.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 >0, 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 "Net::Frame::Layer::TCP 3pm"
.TH Net::Frame::Layer::TCP 3pm "2022-12-04" "perl v5.36.0" "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"
Net::Frame::Layer::TCP \- Transmission Control Protocol layer object
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&   use Net::Frame::Layer::TCP qw(:consts);
\&
\&   # Build a layer
\&   my $layer = Net::Frame::Layer::TCP\->new(
\&      src      => getRandomHighPort(),
\&      dst      => 0,
\&      seq      => getRandom32bitsInt(),
\&      ack      => 0,
\&      x2       => 0,
\&      off      => 0,
\&      flags    => NF_TCP_FLAGS_SYN,
\&      win      => 0xffff,
\&      checksum => 0,
\&      urp      => 0,
\&      options  => \*(Aq\*(Aq,
\&   );
\&   $layer\->pack;
\&
\&   print \*(AqRAW: \*(Aq.$layer\->dump."\en";
\&
\&   # Read a raw layer
\&   my $layer = Net::Frame::Layer::TCP\->new(raw => $raw);
\&
\&   print $layer\->print."\en";
\&   print \*(AqPAYLOAD: \*(Aq.unpack(\*(AqH*\*(Aq, $layer\->payload)."\en"
\&      if $layer\->payload;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This modules implements the encoding and decoding of the \s-1TCP\s0 layer.
.PP
\&\s-1RFC:\s0 ftp://ftp.rfc\-editor.org/in\-notes/rfc793.txt
.PP
See also \fBNet::Frame::Layer\fR for other attributes and methods.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.IP "\fBsrc\fR" 4
.IX Item "src"
.PD 0
.IP "\fBdst\fR" 4
.IX Item "dst"
.PD
Source and destination ports.
.IP "\fBflags\fR" 4
.IX Item "flags"
\&\s-1TCP\s0 flags, see \s-1CONSTANTS.\s0
.IP "\fBwin\fR" 4
.IX Item "win"
The window size.
.IP "\fBseq\fR" 4
.IX Item "seq"
.PD 0
.IP "\fBack\fR" 4
.IX Item "ack"
.PD
Sequence and acknowledgment numbers.
.IP "\fBoff\fR" 4
.IX Item "off"
The size in number of words of the \s-1TCP\s0 header.
.IP "\fBx2\fR" 4
.IX Item "x2"
Reserved field.
.IP "\fBchecksum\fR" 4
.IX Item "checksum"
The \s-1TCP\s0 header checksum.
.IP "\fBurp\fR" 4
.IX Item "urp"
Urgent pointer.
.IP "\fBoptions\fR" 4
.IX Item "options"
\&\s-1TCP\s0 options, as a hexadecimal string.
.PP
The following are inherited attributes. See \fBNet::Frame::Layer\fR for more information.
.IP "\fBraw\fR" 4
.IX Item "raw"
.PD 0
.IP "\fBpayload\fR" 4
.IX Item "payload"
.IP "\fBnextLayer\fR" 4
.IX Item "nextLayer"
.PD
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew\fR" 4
.IX Item "new"
.PD 0
.IP "\fBnew\fR (hash)" 4
.IX Item "new (hash)"
.PD
Object constructor. You can pass attributes that will overwrite default ones. See \fB\s-1SYNOPSIS\s0\fR for default values.
.IP "\fBgetHeaderLength\fR" 4
.IX Item "getHeaderLength"
Returns the header length in bytes, not including \s-1TCP\s0 options.
.IP "\fBgetOptionsLength\fR" 4
.IX Item "getOptionsLength"
Returns options length in bytes.
.IP "\fBcomputeLengths\fR" 4
.IX Item "computeLengths"
Computes various lengths contained within this layer.
.IP "\fBcomputeChecksums\fR ({ type => \s-1PROTO,\s0 src => \s-1IP,\s0 dst => \s-1IP\s0 })" 4
.IX Item "computeChecksums ({ type => PROTO, src => IP, dst => IP })"
In order to compute checksums of \s-1TCP,\s0 you need to pass the protocol type (IPv4, IPv6), the source and destination \s-1IP\s0 addresses (IPv4 for IPv4, IPv6 for IPv6).
.IP "\fBgetKey\fR" 4
.IX Item "getKey"
.PD 0
.IP "\fBgetKeyReverse\fR" 4
.IX Item "getKeyReverse"
.PD
These two methods are basically used to increase the speed when using \fBrecv\fR method from \fBNet::Frame::Simple\fR. Usually, you write them when you need to write \fBmatch\fR method.
.IP "\fBmatch\fR (Net::Frame::Layer::TCP object)" 4
.IX Item "match (Net::Frame::Layer::TCP object)"
This method is mostly used internally. You pass a \fBNet::Frame::Layer::TCP\fR layer as a parameter, and it returns true if this is a response corresponding for the request, or returns false if not.
.PP
The following are inherited methods. Some of them may be overridden in this layer, and some others may not be meaningful in this layer. See \fBNet::Frame::Layer\fR for more information.
.IP "\fBlayer\fR" 4
.IX Item "layer"
.PD 0
.IP "\fBcomputeLengths\fR" 4
.IX Item "computeLengths"
.IP "\fBcomputeChecksums\fR" 4
.IX Item "computeChecksums"
.IP "\fBpack\fR" 4
.IX Item "pack"
.IP "\fBunpack\fR" 4
.IX Item "unpack"
.IP "\fBencapsulate\fR" 4
.IX Item "encapsulate"
.IP "\fBgetLength\fR" 4
.IX Item "getLength"
.IP "\fBgetPayloadLength\fR" 4
.IX Item "getPayloadLength"
.IP "\fBprint\fR" 4
.IX Item "print"
.IP "\fBdump\fR" 4
.IX Item "dump"
.PD
.SH "CONSTANTS"
.IX Header "CONSTANTS"
Load them: use Net::Frame::Layer::TCP qw(:consts);
.IP "\fB\s-1NF_TCP_FLAGS_FIN\s0\fR" 4
.IX Item "NF_TCP_FLAGS_FIN"
.PD 0
.IP "\fB\s-1NF_TCP_FLAGS_SYN\s0\fR" 4
.IX Item "NF_TCP_FLAGS_SYN"
.IP "\fB\s-1NF_TCP_FLAGS_RST\s0\fR" 4
.IX Item "NF_TCP_FLAGS_RST"
.IP "\fB\s-1NF_TCP_FLAGS_PSH\s0\fR" 4
.IX Item "NF_TCP_FLAGS_PSH"
.IP "\fB\s-1NF_TCP_FLAGS_ACK\s0\fR" 4
.IX Item "NF_TCP_FLAGS_ACK"
.IP "\fB\s-1NF_TCP_FLAGS_URG\s0\fR" 4
.IX Item "NF_TCP_FLAGS_URG"
.IP "\fB\s-1NF_TCP_FLAGS_ECE\s0\fR" 4
.IX Item "NF_TCP_FLAGS_ECE"
.IP "\fB\s-1NF_TCP_FLAGS_CWR\s0\fR" 4
.IX Item "NF_TCP_FLAGS_CWR"
.PD
\&\s-1TCP\s0 flags constants.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::Frame::Layer
.SH "AUTHOR"
.IX Header "AUTHOR"
Patrice <GomoR> Auffret
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2006\-2019, Patrice <GomoR> Auffret
.PP
You may distribute this module under the terms of the Artistic license.
See \s-1LICENSE\s0.Artistic file in the source distribution archive.