iPXE
Data Fields
EFI_TCP6_OPTION Struct Reference

EFI_TCP6_OPTION. More...

#include <Tcp6.h>

Data Fields

UINT32 ReceiveBufferSize
 The size of the TCP receive buffer. More...
 
UINT32 SendBufferSize
 The size of the TCP send buffer. More...
 
UINT32 MaxSynBackLog
 The length of incoming connect request queue for a passive instance. More...
 
UINT32 ConnectionTimeout
 The maximum seconds a TCP instance will wait for before a TCP connection established. More...
 
UINT32 DataRetries
 The number of times TCP will attempt to retransmit a packet on an established connection. More...
 
UINT32 FinTimeout
 How many seconds to wait in the FIN_WAIT_2 states for a final FIN flag before the TCP instance is closed. More...
 
UINT32 TimeWaitTimeout
 How many seconds to wait in TIME_WAIT state before the TCP instance is closed. More...
 
UINT32 KeepAliveProbes
 The maximum number of TCP keep-alive probes to send before giving up and resetting the connection if no response from the other end. More...
 
UINT32 KeepAliveTime
 The number of seconds a connection needs to be idle before TCP sends out periodical keep-alive probes. More...
 
UINT32 KeepAliveInterval
 The number of seconds between TCP keep-alive probes after the periodical keep-alive probe if no response. More...
 
BOOLEAN EnableNagle
 Set it to TRUE to enable the Nagle algorithm as defined in RFC896. More...
 
BOOLEAN EnableTimeStamp
 Set it to TRUE to enable TCP timestamps option as defined in RFC7323. More...
 
BOOLEAN EnableWindowScaling
 Set it to TRUE to enable TCP window scale option as defined in RFC7323. More...
 
BOOLEAN EnableSelectiveAck
 Set it to TRUE to enable selective acknowledge mechanism described in RFC 2018. More...
 
BOOLEAN EnablePathMtuDiscovery
 Set it to TRUE to enable path MTU discovery as defined in RFC 1191. More...
 

Detailed Description

EFI_TCP6_OPTION.

Definition at line 127 of file Tcp6.h.

Field Documentation

◆ ReceiveBufferSize

UINT32 EFI_TCP6_OPTION::ReceiveBufferSize

The size of the TCP receive buffer.

Definition at line 131 of file Tcp6.h.

◆ SendBufferSize

UINT32 EFI_TCP6_OPTION::SendBufferSize

The size of the TCP send buffer.

Definition at line 135 of file Tcp6.h.

◆ MaxSynBackLog

UINT32 EFI_TCP6_OPTION::MaxSynBackLog

The length of incoming connect request queue for a passive instance.

When set to zero, the value is implementation specific.

Definition at line 140 of file Tcp6.h.

◆ ConnectionTimeout

UINT32 EFI_TCP6_OPTION::ConnectionTimeout

The maximum seconds a TCP instance will wait for before a TCP connection established.

When set to zero, the value is implementation specific.

Definition at line 146 of file Tcp6.h.

◆ DataRetries

UINT32 EFI_TCP6_OPTION::DataRetries

The number of times TCP will attempt to retransmit a packet on an established connection.

When set to zero, the value is implementation specific.

Definition at line 152 of file Tcp6.h.

◆ FinTimeout

UINT32 EFI_TCP6_OPTION::FinTimeout

How many seconds to wait in the FIN_WAIT_2 states for a final FIN flag before the TCP instance is closed.

This timeout is in effective only if the application has called Close() to disconnect the connection completely. It is also called FIN_WAIT_2 timer in other implementations. When set to zero, it should be disabled because the FIN_WAIT_2 timer itself is against the standard. The default value is 60.

Definition at line 162 of file Tcp6.h.

◆ TimeWaitTimeout

UINT32 EFI_TCP6_OPTION::TimeWaitTimeout

How many seconds to wait in TIME_WAIT state before the TCP instance is closed.

The timer is disabled completely to provide a method to close the TCP connection quickly if it is set to zero. It is against the related RFC documents.

Definition at line 169 of file Tcp6.h.

◆ KeepAliveProbes

UINT32 EFI_TCP6_OPTION::KeepAliveProbes

The maximum number of TCP keep-alive probes to send before giving up and resetting the connection if no response from the other end.

Set to zero to disable keep-alive probe.

Definition at line 175 of file Tcp6.h.

◆ KeepAliveTime

UINT32 EFI_TCP6_OPTION::KeepAliveTime

The number of seconds a connection needs to be idle before TCP sends out periodical keep-alive probes.

When set to zero, the value is implementation specific. It should be ignored if keep- alive probe is disabled.

Definition at line 182 of file Tcp6.h.

◆ KeepAliveInterval

UINT32 EFI_TCP6_OPTION::KeepAliveInterval

The number of seconds between TCP keep-alive probes after the periodical keep-alive probe if no response.

When set to zero, the value is implementation specific. It should be ignored if keep- alive probe is disabled.

Definition at line 189 of file Tcp6.h.

◆ EnableNagle

BOOLEAN EFI_TCP6_OPTION::EnableNagle

Set it to TRUE to enable the Nagle algorithm as defined in RFC896.

Set it to FALSE to disable it.

Definition at line 194 of file Tcp6.h.

◆ EnableTimeStamp

BOOLEAN EFI_TCP6_OPTION::EnableTimeStamp

Set it to TRUE to enable TCP timestamps option as defined in RFC7323.

Set to FALSE to disable it.

Definition at line 199 of file Tcp6.h.

◆ EnableWindowScaling

BOOLEAN EFI_TCP6_OPTION::EnableWindowScaling

Set it to TRUE to enable TCP window scale option as defined in RFC7323.

Set it to FALSE to disable it.

Definition at line 204 of file Tcp6.h.

◆ EnableSelectiveAck

BOOLEAN EFI_TCP6_OPTION::EnableSelectiveAck

Set it to TRUE to enable selective acknowledge mechanism described in RFC 2018.

Set it to FALSE to disable it. Implementation that supports SACK can optionally support DSAK as defined in RFC 2883.

Definition at line 211 of file Tcp6.h.

◆ EnablePathMtuDiscovery

BOOLEAN EFI_TCP6_OPTION::EnablePathMtuDiscovery

Set it to TRUE to enable path MTU discovery as defined in RFC 1191.

Set to FALSE to disable it.

Definition at line 216 of file Tcp6.h.


The documentation for this struct was generated from the following file: