Struct etherparse::TcpHeader
source · pub struct TcpHeader {Show 16 fields
pub source_port: u16,
pub destination_port: u16,
pub sequence_number: u32,
pub acknowledgment_number: u32,
pub ns: bool,
pub fin: bool,
pub syn: bool,
pub rst: bool,
pub psh: bool,
pub ack: bool,
pub urg: bool,
pub ece: bool,
pub cwr: bool,
pub window_size: u16,
pub checksum: u16,
pub urgent_pointer: u16,
/* private fields */
}Expand description
TCP header according to rfc 793.
Field descriptions copied from RFC 793 page 15++
Fields§
§source_port: u16The source port number.
destination_port: u16The destination port number.
sequence_number: u32The sequence number of the first data octet in this segment (except when SYN is present).
If SYN is present the sequence number is the initial sequence number (ISN) and the first data octet is ISN+1. [copied from RFC 793, page 16]
acknowledgment_number: u32If the ACK control bit is set this field contains the value of the next sequence number the sender of the segment is expecting to receive.
Once a connection is established this is always sent.
ns: boolECN-nonce - concealment protection (experimental: see RFC 3540)
fin: boolNo more data from sender
syn: boolSynchronize sequence numbers
rst: boolReset the connection
psh: boolPush Function
ack: boolAcknowledgment field significant
urg: boolUrgent Pointer field significant
ece: boolECN-Echo (RFC 3168)
cwr: boolCongestion Window Reduced (CWR) flag
This flag is set by the sending host to indicate that it received a TCP segment with the ECE flag set and had responded in congestion control mechanism (added to header by RFC 3168).
window_size: u16The number of data octets beginning with the one indicated in the acknowledgment field which the sender of this segment is willing to accept.
checksum: u16Checksum (16 bit one’s complement) of the pseudo ip header, this tcp header and the payload.
urgent_pointer: u16This field communicates the current value of the urgent pointer as a positive offset from the sequence number in this segment.
The urgent pointer points to the sequence number of the octet following the urgent data. This field is only be interpreted in segments with the URG control bit set.
Implementations§
source§impl TcpHeader
impl TcpHeader
sourcepub fn new(
source_port: u16,
destination_port: u16,
sequence_number: u32,
window_size: u16
) -> TcpHeader
pub fn new(
source_port: u16,
destination_port: u16,
sequence_number: u32,
window_size: u16
) -> TcpHeader
Creates a TcpHeader with the given values and the rest initialized with default values.
sourcepub fn data_offset(&self) -> u8
pub fn data_offset(&self) -> u8
The number of 32 bit words in the TCP Header.
This indicates where the data begins. The TCP header (even one including options) is an integral number of 32 bits long.
sourcepub fn header_len(&self) -> u16
pub fn header_len(&self) -> u16
Returns the length of the header including the options.
sourcepub fn options_len(&self) -> usize
pub fn options_len(&self) -> usize
Returns the options size in bytes based on the currently set data_offset. Returns None if the data_offset is smaller then the minimum size or bigger then the maximum supported size.
sourcepub fn options(&self) -> &[u8] ⓘ
pub fn options(&self) -> &[u8] ⓘ
Returns a slice containing the options of the header (size is determined via the data_offset field.
sourcepub fn set_options(
&mut self,
options: &[TcpOptionElement]
) -> Result<(), TcpOptionWriteError>
pub fn set_options(
&mut self,
options: &[TcpOptionElement]
) -> Result<(), TcpOptionWriteError>
Sets the options (overwrites the current options) or returns an error when there is not enough space.
sourcepub fn set_options_raw(&mut self, data: &[u8]) -> Result<(), TcpOptionWriteError>
pub fn set_options_raw(&mut self, data: &[u8]) -> Result<(), TcpOptionWriteError>
Sets the options to the data given.
sourcepub fn options_iterator(&self) -> TcpOptionsIterator<'_> ⓘ
pub fn options_iterator(&self) -> TcpOptionsIterator<'_> ⓘ
Returns an iterator that allows to iterate through all known TCP header options.
sourcepub fn read_from_slice(slice: &[u8]) -> Result<(TcpHeader, &[u8]), ReadError>
pub fn read_from_slice(slice: &[u8]) -> Result<(TcpHeader, &[u8]), ReadError>
Reads a tcp header from a slice
sourcepub fn read<T: Read + Sized>(reader: &mut T) -> Result<TcpHeader, ReadError>
pub fn read<T: Read + Sized>(reader: &mut T) -> Result<TcpHeader, ReadError>
Read a tcp header from the current position
sourcepub fn write<T: Write + Sized>(&self, writer: &mut T) -> Result<(), Error>
pub fn write<T: Write + Sized>(&self, writer: &mut T) -> Result<(), Error>
Write the tcp header to a stream (does NOT calculate the checksum).
sourcepub fn calc_checksum_ipv4(
&self,
ip_header: &Ipv4Header,
payload: &[u8]
) -> Result<u16, ValueError>
pub fn calc_checksum_ipv4(
&self,
ip_header: &Ipv4Header,
payload: &[u8]
) -> Result<u16, ValueError>
Calculates the upd header checksum based on a ipv4 header and returns the result. This does NOT set the checksum.
sourcepub fn calc_checksum_ipv4_raw(
&self,
source_ip: [u8; 4],
destination_ip: [u8; 4],
payload: &[u8]
) -> Result<u16, ValueError>
pub fn calc_checksum_ipv4_raw(
&self,
source_ip: [u8; 4],
destination_ip: [u8; 4],
payload: &[u8]
) -> Result<u16, ValueError>
Calculates the checksum for the current header in ipv4 mode and returns the result. This does NOT set the checksum.
sourcepub fn calc_checksum_ipv6(
&self,
ip_header: &Ipv6Header,
payload: &[u8]
) -> Result<u16, ValueError>
pub fn calc_checksum_ipv6(
&self,
ip_header: &Ipv6Header,
payload: &[u8]
) -> Result<u16, ValueError>
Calculates the upd header checksum based on a ipv6 header and returns the result. This does NOT set the checksum..
sourcepub fn calc_checksum_ipv6_raw(
&self,
source: &[u8; 16],
destination: &[u8; 16],
payload: &[u8]
) -> Result<u16, ValueError>
pub fn calc_checksum_ipv6_raw(
&self,
source: &[u8; 16],
destination: &[u8; 16],
payload: &[u8]
) -> Result<u16, ValueError>
Calculates the checksum for the current header in ipv6 mode and returns the result. This does NOT set the checksum.