Implements flags for TCPHeader.

Header Definition

 Fixnum (1 bit)  :urg
 Fixnum (1 bit)  :ack
 Fixnum (1 bit)  :psh
 Fixnum (1 bit)  :rst
 Fixnum (1 bit)  :syn
 Fixnum (1 bit)  :fin

Flags can typically be set by setting them either to 1 or 0, or to true or false.

Methods
A
F
N
P
R
S
T
U
Z
Included Modules
Class Public methods
new(args={})

Source: show 

# File lib/packetfu/protos/tcp.rb, line 140
                def initialize(args={})
                        # This technique attemts to ensure that flags are always 0 (off)
                        # or 1 (on). Statements like nil and false shouldn't be lurking in here.
                        if args.nil? || args.size.zero?
                                super( 0, 0, 0, 0, 0, 0)
                        else
                                super(
                                        (args[:urg] ? 1 : 0), 
                                        (args[:ack] ? 1 : 0), 
                                        (args[:psh] ? 1 : 0), 
                                        (args[:rst] ? 1 : 0), 
                                        (args[:syn] ? 1 : 0), 
                                        (args[:fin] ? 1 : 0)
                                )
                        end
                end
Instance Public methods
ack=(i)

Setter for the Acknowlege flag.

Source: show 

# File lib/packetfu/protos/tcp.rb, line 176
                def ack=(i); self[:ack] = zero_or_one(i); end
fin=(i)

Setter for the Finish flag.

Source: show 

# File lib/packetfu/protos/tcp.rb, line 184
                def fin=(i); self[:fin] = zero_or_one(i); end
psh=(i)

Setter for the Push flag.

Source: show 

# File lib/packetfu/protos/tcp.rb, line 178
                def psh=(i); self[:psh] = zero_or_one(i); end
read(str)

Reads a string to populate the object.

Source: show 

# File lib/packetfu/protos/tcp.rb, line 187
                def read(str)
                        force_binary(str)
                        return self if str.nil?
                        if 1.respond_to? :ord
                                byte = str[0].ord
                        else
                                byte = str[0]
                        end
                        self[:urg] = byte & 0b00100000 == 0b00100000 ? 1 : 0
                        self[:ack] = byte & 0b00010000 == 0b00010000 ? 1 : 0
                        self[:psh] = byte & 0b00001000 == 0b00001000 ? 1 : 0
                        self[:rst] = byte & 0b00000100 == 0b00000100 ? 1 : 0
                        self[:syn] = byte & 0b00000010 == 0b00000010 ? 1 : 0
                        self[:fin] = byte & 0b00000001 == 0b00000001 ? 1 : 0
                        self
                end
rst=(i)

Setter for the Reset flag.

Source: show 

# File lib/packetfu/protos/tcp.rb, line 180
                def rst=(i); self[:rst] = zero_or_one(i); end
syn=(i)

Setter for the Synchronize flag.

Source: show 

# File lib/packetfu/protos/tcp.rb, line 182
                def syn=(i); self[:syn] = zero_or_one(i); end
to_i()

Returns the TcpFlags as an integer. Also not a great candidate for to_s due to the short bitspace.

Source: show 

# File lib/packetfu/protos/tcp.rb, line 159
                def to_i
                        (urg.to_i << 5) + (ack.to_i << 4) + (psh.to_i << 3) + 
                        (rst.to_i << 2) + (syn.to_i << 1) + fin.to_i
                end
urg=(i)

Setter for the Urgent flag.

Source: show 

# File lib/packetfu/protos/tcp.rb, line 174
                def urg=(i); self[:urg] = zero_or_one(i); end
zero_or_one(i=0)

Helper to determine if this flag is a 1 or a 0.

Source: show 

# File lib/packetfu/protos/tcp.rb, line 165
                def zero_or_one(i=0)
                        if i == 0 || i == false || i == nil
                                0
                        else
                                1
                        end
                end