sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixing function headers.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7114 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
niry
2008-12-24 08:14:19 +00:00
parent 0c323d071d
commit 276dcc1b14
12 changed files with 100 additions and 95 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
MdeModulePkg/Universal/Network/Tcp4Dxe/Socket.h
View File

@@ -114,7 +114,7 @@ typedef enum {
#define SOCK_IS_NO_MORE_DATA(Sock) (0 != ((Sock)->Flag & SO_NO_MORE_DATA))
#define SOCK_SIGNATURE SIGNATURE_32 ('S', 'O', 'C', 'K')
#define SOCK_SIGNATURE EFI_SIGNATURE_32 ('S', 'O', 'C', 'K')
#define SOCK_FROM_THIS(a) CR ((a), SOCKET, NetProtocol, SOCK_SIGNATURE)
@@ -197,17 +197,6 @@ typedef enum {
SOCK_STREAM ///< This socket providing stream service
} SOCK_TYPE;
///
/// The handler of protocol for request from socket.
///
typedef
EFI_STATUS
(*SOCK_PROTO_HANDLER) (
IN SOCKET *Socket, ///< The socket issuing the request to protocol
IN SOCK_REQUEST Request, ///< The request issued by socket
IN VOID *RequestData ///< The request related data
);
///
/// The buffer structure of rcvd data and send data used by socket.
///
@@ -217,7 +206,27 @@ typedef struct _SOCK_BUFFER {
NET_BUF_QUEUE *DataQueue; ///< The queue to buffer data
} SOCK_BUFFER;
/**
The handler of protocol for request from socket.
@param Socket The socket issuing the request to protocol
@param Request The request issued by socket
@param RequestData The request related data
@retval EFI_SUCCESS The socket request is completed successfully.
@retval other The error status returned by the corresponding TCP
layer function.
**/
typedef
EFI_STATUS
(*SOCK_PROTO_HANDLER) (
IN SOCKET *Socket,
IN SOCK_REQUEST Request,
IN VOID *RequestData
);
//
// Socket provided oprerations for low layer protocol
//
@@ -241,7 +250,9 @@ SockSetState (
/**
Called by the low layer protocol to indicate the socket a connection is
established. This function just changes the socket's state to SO_CONNECTED
established.
This function just changes the socket's state to SO_CONNECTED
and signals the token used for connection establishment.
@param Sock Pointer to the socket associated with the
@@ -254,9 +265,10 @@ SockConnEstablished (
);
/**
Called by the low layer protocol to indicate the connection is closed; This
function flushes the socket, sets the state to SO_CLOSED and signals the close
token.
Called by the low layer protocol to indicate the connection is closed.
This function flushes the socket, sets the state to SO_CLOSED and signals
the close token.
@param Sock Pointer to the socket associated with the closed
connection.
@@ -268,7 +280,8 @@ SockConnClosed (
);
/**
Called by low layer protocol to indicate that some data is sent or processed;
Called by low layer protocol to indicate that some data is sent or processed.
This function trims the sent data in the socket send buffer, signals the data
token if proper.
@@ -305,10 +318,10 @@ SockGetDataToSend (
/**
Called by the low layer protocol to indicate that there
will be no more data from the communication peer; This
function set the socket's state to SO_NO_MORE_DATA and
signal all queued IO tokens with the error status
EFI_CONNECTION_FIN.
will be no more data from the communication peer.
This function set the socket's state to SO_NO_MORE_DATA and
signal all queued IO tokens with the error status EFI_CONNECTION_FIN.
@param Sock Pointer to the socket.
@@ -319,7 +332,8 @@ SockNoMoreData (
);
/**
Called by the low layer protocol to deliver received data to socket layer;
Called by the low layer protocol to deliver received data to socket layer.
This function will append the data to the socket receive buffer, set ther
urgent data length and then check if any receive token can be signaled.
@@ -720,8 +734,8 @@ SockClose (
**/
EFI_STATUS
SockGetMode (
IN SOCKET *Sock,
IN VOID *Mode
IN SOCKET *Sock,
IN OUT VOID *Mode
);
/**