#include <NetworkPkg/TcpDxe/Socket.h>

Data Fields
UINT32	Signature
	Signature of the socket.

EFI_HANDLE	SockHandle
	The virtual handle of the socket.

EFI_HANDLE	DriverBinding
	Socket's driver binding protocol.

EFI_DEVICE_PATH_PROTOCOL *	ParentDevicePath

EFI_DEVICE_PATH_PROTOCOL *	DevicePath

LIST_ENTRY	Link

UINT8	ConfigureState

SOCK_TYPE	Type

UINT8	State

UINT16	Flag

EFI_LOCK	Lock
	The lock of socket.

SOCK_BUFFER	SndBuffer
	Send buffer of application's data.

SOCK_BUFFER	RcvBuffer
	Receive buffer of received data.

EFI_STATUS	SockError
	The error returned by low layer protocol.

BOOLEAN	InDestroy

UINT32	BackLog
	the limit of connection to this socket

UINT32	ConnCnt
	the current count of connections to it

SOCKET *	Parent
	listening parent that accept the connection

LIST_ENTRY	ConnectionList
	the connections maintained by this socket

LIST_ENTRY	ListenTokenList

LIST_ENTRY	RcvTokenList

LIST_ENTRY	SndTokenList

LIST_ENTRY	ProcessingSndTokenList

SOCK_COMPLETION_TOKEN *	ConnectionToken
	app's token to signal if connected

SOCK_COMPLETION_TOKEN *	CloseToken
	app's token to signal if closed

SOCK_PROTO_HANDLER	ProtoHandler
	The request handler of protocol.

UINT8	ProtoReserved [PROTO_RESERVED_LEN]
	Data fields reserved for protocol.

UINT8	IpVersion

NET_PROTOCOL	NetProtocol
	TCP4 or TCP6 protocol socket used.

SOCK_CREATE_CALLBACK	CreateCallback
	Callback after created.

SOCK_DESTROY_CALLBACK	DestroyCallback
	Callback before destroyed.

VOID *	Context
	The context of the callback.

Detailed Description

The socket structure representing a network service access point.

Definition at line 456 of file Socket.h.

Field Documentation

◆ BackLog

UINT32 _TCP_SOCKET::BackLog

the limit of connection to this socket

Definition at line 479 of file Socket.h.

◆ CloseToken

SOCK_COMPLETION_TOKEN* _TCP_SOCKET::CloseToken

app's token to signal if closed

Definition at line 492 of file Socket.h.

◆ ConfigureState

UINT8 _TCP_SOCKET::ConfigureState

Definition at line 466 of file Socket.h.

◆ ConnCnt

UINT32 _TCP_SOCKET::ConnCnt

the current count of connections to it

Definition at line 480 of file Socket.h.

◆ ConnectionList

LIST_ENTRY _TCP_SOCKET::ConnectionList

the connections maintained by this socket

Definition at line 482 of file Socket.h.

◆ ConnectionToken

SOCK_COMPLETION_TOKEN* _TCP_SOCKET::ConnectionToken

app's token to signal if connected

Definition at line 491 of file Socket.h.

◆ Context

VOID* _TCP_SOCKET::Context

The context of the callback.

Definition at line 505 of file Socket.h.

◆ CreateCallback

SOCK_CREATE_CALLBACK _TCP_SOCKET::CreateCallback

Callback after created.

Definition at line 503 of file Socket.h.

◆ DestroyCallback

SOCK_DESTROY_CALLBACK _TCP_SOCKET::DestroyCallback

Callback before destroyed.

Definition at line 504 of file Socket.h.

◆ DevicePath

EFI_DEVICE_PATH_PROTOCOL* _TCP_SOCKET::DevicePath

Definition at line 464 of file Socket.h.

◆ DriverBinding

EFI_HANDLE _TCP_SOCKET::DriverBinding

Socket's driver binding protocol.

Definition at line 462 of file Socket.h.

◆ Flag

UINT16 _TCP_SOCKET::Flag

Definition at line 469 of file Socket.h.

◆ InDestroy

BOOLEAN _TCP_SOCKET::InDestroy

Definition at line 474 of file Socket.h.

◆ IpVersion

UINT8 _TCP_SOCKET::IpVersion

Definition at line 498 of file Socket.h.

◆ Link

LIST_ENTRY _TCP_SOCKET::Link

Definition at line 465 of file Socket.h.

◆ ListenTokenList

LIST_ENTRY _TCP_SOCKET::ListenTokenList

Definition at line 486 of file Socket.h.

◆ Lock

EFI_LOCK _TCP_SOCKET::Lock

The lock of socket.

Definition at line 470 of file Socket.h.

◆ NetProtocol

NET_PROTOCOL _TCP_SOCKET::NetProtocol

TCP4 or TCP6 protocol socket used.

Definition at line 499 of file Socket.h.

◆ Parent

SOCKET* _TCP_SOCKET::Parent

listening parent that accept the connection

Definition at line 481 of file Socket.h.

◆ ParentDevicePath

EFI_DEVICE_PATH_PROTOCOL* _TCP_SOCKET::ParentDevicePath

Definition at line 463 of file Socket.h.

◆ ProcessingSndTokenList

LIST_ENTRY _TCP_SOCKET::ProcessingSndTokenList

Definition at line 489 of file Socket.h.

◆ ProtoHandler

SOCK_PROTO_HANDLER _TCP_SOCKET::ProtoHandler

The request handler of protocol.

Definition at line 496 of file Socket.h.

◆ ProtoReserved

UINT8 _TCP_SOCKET::ProtoReserved[PROTO_RESERVED_LEN]

Data fields reserved for protocol.

Definition at line 497 of file Socket.h.

◆ RcvBuffer

SOCK_BUFFER _TCP_SOCKET::RcvBuffer

Receive buffer of received data.

Definition at line 472 of file Socket.h.

◆ RcvTokenList

LIST_ENTRY _TCP_SOCKET::RcvTokenList

Definition at line 487 of file Socket.h.

◆ Signature

UINT32 _TCP_SOCKET::Signature

Signature of the socket.

Definition at line 460 of file Socket.h.

◆ SndBuffer

SOCK_BUFFER _TCP_SOCKET::SndBuffer

Send buffer of application's data.

Definition at line 471 of file Socket.h.

◆ SndTokenList

LIST_ENTRY _TCP_SOCKET::SndTokenList

Definition at line 488 of file Socket.h.

◆ SockError

EFI_STATUS _TCP_SOCKET::SockError

The error returned by low layer protocol.

Definition at line 473 of file Socket.h.

◆ SockHandle

EFI_HANDLE _TCP_SOCKET::SockHandle

The virtual handle of the socket.

Definition at line 461 of file Socket.h.

◆ State

UINT8 _TCP_SOCKET::State

Definition at line 468 of file Socket.h.

◆ Type

SOCK_TYPE _TCP_SOCKET::Type

Definition at line 467 of file Socket.h.

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

NetworkPkg/TcpDxe/Socket.h

Data Fields