Class TCPOption

Options for the TCP Layer, inherits from Base_Object

Tables

TCPOption.new_args TCPOption constructor arguments
TCPOption.MPJoin_args The MPTCPJoin Option arguments
TCPOption.MPCapable_args The MPTCPCapable Option arguments

Methods

TCPOption:new ([args]) Create a 'blank' TCPOption
TCPOption:kind (kind) Set the Option Kind
TCPOption:data (data) Set the Option data (raw access)
TCPOption:new_nop () Create a new NOP Option (Kind=1)
TCPOption:new_eol () Create a new EOL Option (Kind=0)
TCPOption:new_sackp () Create a new SACKPermitted Option
TCPOption:new_sack (a) Create a new SACK Option
TCPOption:new_mss (the) Create a new MSS Option
TCPOption:new_wscale (wscale) Create a new WindowScale Option
TCPOption:new_mpjoin ([the]) Create a new MPTCPJoin Option
TCPOption:new_mpcapable ([the]) Create a new MPTCPCapable Option


Tables

TCPOption.new_args
TCPOption constructor arguments

Fields:

  • copy num
  • length num
  • data table opaque list of bytes
TCPOption.MPJoin_args
The MPTCPJoin Option arguments

Fields:

  • token num
  • nonce num
  • id num address ID
  • backup bool

See also:

TCPOption.MPCapable_args
The MPTCPCapable Option arguments

Fields:

  • skey num sender key
  • rkey num receiver key
  • csum bool checksum

See also:

Methods

TCPOption:new ([args])
Create a 'blank' TCPOption

Parameters:

Returns:

    TCPOption
TCPOption:kind (kind)
Set the Option Kind

Parameters:

  • kind num
TCPOption:data (data)
Set the Option data (raw access)

Parameters:

TCPOption:new_nop ()
Create a new NOP Option (Kind=1)

Returns:

    TCPOption
TCPOption:new_eol ()
Create a new EOL Option (Kind=0)

Returns:

    TCPOption
TCPOption:new_sackp ()
Create a new SACKPermitted Option

Returns:

    TCPOption
TCPOption:new_sack (a)
Create a new SACK Option

Parameters:

  • a table list of pairs, either grouped in subtables or in one single flat table

Returns:

    TCPOption

Usage:

    l = TCPOption:new_sack{1, 2, 3, 4} -- Will create a SACK option with pairs (1,2) and (3,4)
     l = TCPOption:new_sack{{1, 2}, {3, 4}} -- Equivalent to the above
TCPOption:new_mss (the)
Create a new MSS Option

Parameters:

  • the num MSS value value

Returns:

    TCPOption
TCPOption:new_wscale (wscale)
Create a new WindowScale Option

Parameters:

  • wscale num the window scaling factor

Returns:

    TCPOption
TCPOption:new_mpjoin ([the])
Create a new MPTCPJoin Option

Parameters:

Returns:

    TCPOption
TCPOption:new_mpcapable ([the])
Create a new MPTCPCapable Option

Parameters:

Returns:

    TCPOption
generated by LDoc 1.4.6 Last updated 2017-10-04 11:48:45