.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Wx::Socket 3pm"
.TH Wx::Socket 3pm "2014-03-08" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Wx::Socket \- wxSocket* classes
.SH "USAGE"
.IX Header "USAGE"
.Vb 3
\&  use Wx qw(:socket) ;
\&  use Wx::Event qw(EVT_SOCKET_INPUT EVT_SOCKET_LOST) ;
\&  use Wx::Event qw(EVT_SOCKET_CONNECTION) ;
\&
\&  ##########
\&  # CLIENT #
\&  ##########
\&
\&  my $sock = Wx::SocketClient\->new(wxSOCKET_WAITALL);
\&
\&  EVT_SOCKET_INPUT($parent , $sock , \e&onInput ) ;
\&  EVT_SOCKET_LOST($parent , $sock , \e&onClose ) ;
\&
\&  $sock\->Connect(\*(Aqlocalhost\*(Aq,5050) ;
\&
\&  if (! $sock\->IsConnected ) { print "ERROR\en" ;}
\&
\&  sub onInput {
\&    my ( $sock , $this , $evt ) = @_ ;
\&    my $length = 123;
\&    my $buffer ;
\&    $sock\->Read($buffer , 1024 , $length ) ;
\&  }
\&
\&  ##########
\&  # SERVER #
\&  ##########
\&
\&  my $sock = Wx::SocketServer\->new(\*(Aqlocalhost\*(Aq,5050,wxSOCKET_WAITALL);
\&
\&  EVT_SOCKET_CONNECTION($parent , $sock , \e&onConnect ) ;
\&
\&  if ( !$sock\->Ok ) { print "ERROR\en" ;}
\&
\&  sub onConnect {
\&    my ( $sock , $this , $evt ) = @_ ;
\&    my $client = $sock\->Accept(0) ;
\&
\&    my ($local_host,$local_port) = $client\->GetLocal ;
\&    my ($peer_host,$peer_port) = $client\->GetPeer ;
\&
\&    $client\->Write("This is a data test!\en") ;
.Ve
.PP
\&... or ...
.PP
.Vb 1
\&    $client\->Write( $data , length($data) ) ;
\&
\&    $client\->Close ;
\&  }
.Ve
.SH "METHODS"
.IX Header "METHODS"
All the methods work as in wxWidgets (see the documentation).
.PP
The functions for reading data (Read, ReadMsg, Peek) take 3 arguments,
like the Perl \fIread()\fR function:
.PP
.Vb 2
\&  ## To read the data into the variable
\&  $sock\->Read($buffer , 1024) ;
.Ve
.PP
\&... or ...
.PP
.Vb 2
\&  ## To append data at the given offset:
\&  $sock\->Read($buffer , 1024 , $offset ) ;
.Ve
.PP
The write functions (Write, WriteMsg, Unread) can be used with
1 or 2 arguments:
.PP
.Vb 1
\&  $client\->Write("This is a data test!\en") ;
\&
\&  $client\->Write($data , $length) ;
.Ve
.SH "EVENTS"
.IX Header "EVENTS"
The events are:
.PP
.Vb 6
\&    EVT_SOCKET
\&    EVT_SOCKET_ALL
\&    EVT_SOCKET_INPUT
\&    EVT_SOCKET_OUTPUT
\&    EVT_SOCKET_CONNECTION
\&    EVT_SOCKET_LOST
.Ve
.PP
The \s-1EVT_SOCKET\s0 works as in wxWidgets, the others are wxPerl extensions.
.PP
Note that \s-1EVT_SOCKET\s0 events of wxSocketClient and wxSocketServer
work differently than other event types.
.PP
First you need to set the event handler:
.PP
.Vb 1
\&    $sock\->SetEventHandler($handler, $id) ;
.Ve
.PP
Then you set what types of event you want to receive:
.PP
.Vb 3
\&    ## this select all.
\&    $sock\->SetNotify(wxSOCKET_INPUT_FLAG|wxSOCKET_OUTPUT_FLAG|
\&                     wxSOCKET_CONNECTION_FLAG|wxSOCKET_LOST_FLAG) ;
.Ve
.PP
Enable the event notification:
.PP
.Vb 1
\&    $sock\->Notify(1) ;
.Ve
.PP
And only after this use:
.PP
.Vb 3
\&    ## note that $handler must be the same that was used in
\&    ## SetEventHandler
\&    EVT_SOCKET($handler, $id , sub{...} )
.Ve
.PP
To make the events easier to use, all the proccess is automatic,
and you just use:
.PP
.Vb 4
\&    EVT_SOCKET_INPUT($handler , $socket , sub{...} )
\&    EVT_SOCKET_OUTPUT($handler , $socket , sub{...} )
\&    EVT_SOCKET_CONNECTION($handler , $socket , sub{...} )
\&    EVT_SOCKET_LOST($handler , $socket , sub{...} )
\&
\&    ## This is for the events not used yet by the above:
\&    EVT_SOCKET_ALL($parent , $socket , sub{...} )
.Ve
.PP
** The new way is better to handle more than one socket in the same time too.
   Take a look in the demos.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Wx, The wxWxwindows documentation at <http://www.wxwindows.org/>
.SH "AUTHOR"
.IX Header "AUTHOR"
Graciliano M. P. <gm@virtuasites.com.br>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.