.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) .\" .\" 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" '' '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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "Pcap 3pm" .TH Pcap 3pm "2008-01-28" "perl v5.10.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 .Vb 3 \& ## Need an IO::Handle to $kernel\->select_read() upon \& $heap\->{fdh} = IO::Handle\->new_from_fd( $heap\->{fd}, "r" ) \& or die "Can\*(Aqt create IO::Handle from pcap fd: $!\en"; .Ve .SH "NAME" POE::Component::Pcap \- POE Interface to Net::Pcap .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use POE::Component::Pcap; \& \& POE::Component::Pcap\->spawn( \& Alias => \*(Aqpcap\*(Aq, \& Device => \*(Aqeth0\*(Aq, \& Filter => \*(Aqhost fooble or host blort\*(Aq, \& Dispatch => \*(Aqgot_packet\*(Aq, \& Session => $my_session_id, \& ); \& \& $poe_kernel\->post( pcap => open_live => \& \*(Aqeth0\*(Aq, 80, 1, 100 ); \& \& $poe_kernel\->post( pcap => set_filter => \*(Aqarp or host zooble\*(Aq ); \& \& $poe_kernel\->post( pcap => set_dispatch => \*(Aqtarget_state\*(Aq ); \& \& $poe_kernel\->post( pcap => \*(Aqrun\*(Aq ); \& \& $poe_kernel\->post( pcap => \*(Aqshutdown\*(Aq ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" POE::Component::Pcap provides a wrapper for using the Net::Pcap module from \s-1POE\s0 programs. The component creates a separate session which posts events to a specified session and state when packets are available. .SS "\s-1ARGUMENTS\s0" .IX Subsection "ARGUMENTS" .IP "Alias" 4 .IX Item "Alias" The alias for the Pcap session. Used to post events such as \f(CW\*(C`run\*(C'\fR and \f(CW\*(C`shutdown\*(C'\fR to control the component. Defaults to \f(CW\*(C`pcap\*(C'\fR if not specified. .IP "Device" 4 .IX Item "Device" As a shortcut, the device for Net::Pcap to watch may be specified when creating the component. If this argument is used, Net::Pcap::open_live will be called with a snaplen of 80 octets, a timeout of 100ms, and the interface will be put in promiscuous mode. If these values are not suitable, post an \f(CW\*(C`open_live\*(C'\fR event instead. .IP "Filter" 4 .IX Item "Filter" Another shortcut, calls Net::Pcap::compile and Net::Pcap::setfilter to set a packet filter. This can only be used if the \fBDevice\fR argument is also given; otherwise a \f(CW\*(C`set_filter\*(C'\fR event should be posted after an \f(CW\*(C`open_live\*(C'\fR event (since Net::Pcap must have a \f(CW\*(C`pcap_t\*(C'\fR descriptor to work with). .IP "Dispatch" 4 .IX Item "Dispatch" .PD 0 .IP "Session" 4 .IX Item "Session" .PD These specify the session and state to which events should be posted when packets are received. .SS "\s-1EVENTS\s0" .IX Subsection "EVENTS" The following examples assume that the component's alias has been set to the default value of \fBpcap\fR. .IP "open_live" 4 .IX Item "open_live" .Vb 2 \& $_[KERNEL]\->post( pcap => open_live \& => \*(Aqdevice\*(Aq, [snaplen], [promsic?], [timeout] ); .Ve .Sp Calls Net::Pcap::open_live. The device name must be specified. The snaplen, promiscuous, and timeout parameters default to 80, 1, and 100 respectively. This event must be posted (or the \fBDevice\fR argument must have been passed to \fIspawn()\fR) before anything else can be done with the component. .IP "set_filter" 4 .IX Item "set_filter" .Vb 2 \& $_[KERNEL]\->post( pcap => set_filter \& => \*(Aqhost fooble or host blort\*(Aq ) .Ve .Sp Sets the Net::Pcap capture filter. See \fItcpdump\fR\|(8) for details on the filter language used by \fIpcap\fR\|(3). .IP "set_dispatch" 4 .IX Item "set_dispatch" .Vb 2 \& $_[KERNEL]\->post( pcap => set_dispatch \& => \*(Aqtarget_state\*(Aq, \*(Aqtarget_session\*(Aq ); .Ve .Sp Sets the state and session to which events are sent when packets are recevied. The target session will default to the sender of the event if not specified. .Sp The event posted will have a single argument (available as \fB\s-1ARG0\s0\fR) which will be an array reference containing the \f(CW$hdr\fR and \f(CW$pkt\fR parameters from Net::Pcap. See the \fINet::Pcap\fR\|(3) documentation for more details. .IP "run" 4 .IX Item "run" .Vb 1 \& $_[KERNEL]\->post( pcap => \*(Aqrun\*(Aq ); .Ve .Sp Causes the component to register a select_read and start watching for packets. .IP "shutdown" 4 .IX Item "shutdown" .Vb 1 \& $_[KERNEL]\->post( pcap => \*(Aqshutdown\*(Aq ); .Ve .Sp Shuts the component down. Causes Net::Pcap::close to be called. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fINet::Pcap\fR\|(3), \fIpcap\fR\|(3), \fItcpdump\fR\|(8), \s-1\fIPOE\s0\fR\|(3), \fIPOE::Component\fR\|(3) .SH "AUTHOR" .IX Header "AUTHOR" Mike Fletcher, .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2000\-2001, Mike Fletcher. All Rights Reserved. This is free software; you may redistribute it and/or modify it under the same terms as Perl itself.