Lines Matching defs:SOCKET
2 Socket header file.
50 // When a socket is created it enters into SO_UNCONFIGURED,
51 // no actions can be taken on this socket, only after calling
52 // SockConfigure. The state transition diagram of socket is
61 // A passive socket can only go into SO_LISTENING and
63 // when a socket is undergoing a protocol procedure such
70 /// Socket state
79 /// Socket configure state
87 Set socket SO_NO_MORE_DATA flag.
89 @param Sock Pointer to the socket
95 Check whether the socket is unconfigured.
97 @param Sock Pointer to the socket
99 @retval True The socket is unconfigued
100 @retval False The socket is not unconfigued
106 Check whether the socket is configured.
108 @param Sock Pointer to the socket
110 @retval True The socket is configued
111 @retval False The socket is not configued
119 Check whether the socket is configured to active mode.
121 @param Sock Pointer to the socket
123 @retval True The socket is configued to active mode
124 @retval False The socket is not configued to active mode
131 Check whether the socket is configured to passive mode.
133 @param Sock Pointer to the socket
135 @retval True The socket is configued to passive mode
136 @retval False The socket is not configued to passive mode
143 Check whether the socket is mapped.
145 @param Sock Pointer to the socket
147 @retval True The socket is no mapping
148 @retval False The socket is mapped
155 Check whether the socket is closed.
157 @param Sock Pointer to the socket
159 @retval True The socket is closed
160 @retval False The socket is not closed
166 Check whether the socket is listening.
168 @param Sock Pointer to the socket
170 @retval True The socket is listening
171 @retval False The socket is not listening
177 Check whether the socket is connecting.
179 @param Sock Pointer to the socket
181 @retval True The socket is connecting
182 @retval False The socket is not connecting
188 Check whether the socket has connected.
190 @param Sock Pointer to the socket
192 @retval True The socket has connected
193 @retval False The socket has not connected
199 Check whether the socket is disconnecting.
201 @param Sock Pointer to the socket
203 @retval True The socket is disconnecting
204 @retval False The socket is not disconnecting
210 Check whether the socket is no more data.
212 @param Sock Pointer to the socket
214 @retval True The socket is no more data
215 @retval False The socket still has data
223 @param Sock Pointer to the socket
232 @param Sock Pointer to the socket
242 @param Sock Pointer to the socket
252 @param Sock Pointer to the socket
261 @param Sock Pointer to the socket
271 @param Sock Pointer to the socket
279 Set the backlog value of the socket.
281 @param Sock Pointer to the socket
288 Get the backlog value of the socket.
290 @param Sock Pointer to the socket
298 Set the socket with error state.
300 @param Sock Pointer to the socket
314 #define SOCK_FROM_THIS(a) CR ((a), SOCKET, NetProtocol, SOCK_SIGNATURE)
321 typedef struct _SOCKET SOCKET;
324 /// Socket completion token
345 /// The request issued from socket layer to protocol layer.
347 #define SOCK_ATTACH 0 ///< Attach current socket to a new PCB
348 #define SOCK_DETACH 1 ///< Detach current socket from the PCB
354 #define SOCK_CONSUMED 7 ///< Application has retrieved data from socket
364 /// The socket type.
367 SockDgram, ///< This socket providing datagram service
368 SockStream ///< This socket providing stream service
372 /// The buffer structure of rcvd data and send data used by socket.
381 The handler of protocol for request from socket.
383 @param Socket The socket issuing the request to protocol
384 @param Request The request issued by socket
387 @retval EFI_SUCCESS The socket request is completed successfully.
395 IN SOCKET *Socket,
402 // Socket provided oprerations for low layer protocol
406 // Socket provided operations for user interface
410 Set the state of the socket.
412 @param Sock Pointer to the socket.
413 @param State The new socket state to be set.
418 IN OUT SOCKET *Sock,
423 Called by the low layer protocol to indicate the socket a connection is
426 This function just changes the socket's state to SO_CONNECTED
429 @param Sock Pointer to the socket associated with the
435 IN SOCKET *Sock
441 This function flushes the socket, sets the state to SO_CLOSED and signals
444 @param Sock Pointer to the socket associated with the closed
450 IN OUT SOCKET *Sock
456 This function trims the sent data in the socket send buffer, signals the data
459 @param Sock Pointer to the socket.
465 IN SOCKET *Sock,
470 Called by the low layer protocol to copy some data in socket send
474 @param Sock Pointer to the socket.
484 IN SOCKET *Sock,
494 This function set the socket's state to SO_NO_MORE_DATA and
497 @param Sock Pointer to the socket.
502 IN OUT SOCKET *Sock
506 Called by the low layer protocol to deliver received data to socket layer.
508 This function will append the data to the socket receive buffer, set ther
511 @param Sock Pointer to the socket.
519 IN SOCKET *Sock,
525 Get the length of the free space of the specific socket buffer.
527 @param Sock Pointer to the socket.
528 @param Which Flag to indicate which socket buffer to check,
536 IN SOCKET *Sock,
541 Clone a new socket including its associated protocol control block.
543 @param Sock Pointer to the socket to be cloned.
545 @return Pointer to the newly cloned socket. If NULL, error condition occurred.
548 SOCKET *
550 IN SOCKET *Sock
555 set socket error code after error is received.
557 @param Sock Pointer to the socket.
563 IN OUT SOCKET *Sock,
573 IN SOCKET *This,
583 IN SOCKET *This,
588 /// The initialize data for create a new socket.
594 SOCKET *Parent; ///< The parent of this socket
595 UINT32 BackLog; ///< The connection limit for listening socket
599 ///< wanted to install on socket
602 // Callbacks after socket is created and before socket is to be destroyed.
614 SOCK_PROTO_HANDLER ProtoHandler; ///< The handler of protocol for socket request
628 /// The socket structure representing a network service access point
633 // Socket description information
635 UINT32 Signature; ///< Signature of the socket
636 EFI_HANDLE SockHandle; ///< The virtual handle of the socket
637 EFI_HANDLE DriverBinding; ///< Socket's driver binding protocol
645 EFI_LOCK Lock; ///< The lock of socket
654 UINT32 BackLog; ///< the limit of connection to this socket
656 SOCKET *Parent; ///< listening parent that accept the connection
657 LIST_ENTRY ConnectionList; ///< the connections maintained by this socket
675 NET_PROTOCOL NetProtocol; ///< TCP or UDP protocol socket used
678 // Callbacks after socket is created and before socket is to be destroyed.
686 /// The token structure buffered in socket layer.
692 SOCKET *Sock; ///< The poninter to the socket this token
712 Create a socket and its associated protocol control block
716 @param SockInitData Inital data to setting the socket.
718 @return Pointer to the newly created socket. If NULL, error condition occured.
721 SOCKET *
727 Destroy the socket Sock and its associated protocol control block.
729 @param Sock The socket to be destroyed.
731 @retval EFI_SUCCESS The socket Sock is destroyed successfully.
732 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket.
737 IN SOCKET *Sock
741 Configure the specific socket Sock using configuration data ConfigData.
743 @param Sock Pointer to the socket to be configured.
746 @retval EFI_SUCCESS The socket is configured successfully.
747 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket or the
748 socket is already configured.
753 IN SOCKET *Sock,
760 @param Sock Pointer to the socket to initiate the initate the
766 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket, or the
767 socket is closed, or the socket is not configured to
769 this socket's lists.
772 @retval EFI_NOT_STARTED The socket is not configured.
777 IN SOCKET *Sock,
785 @param Sock Pointer to the socket to accept connections.
790 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket, or the
791 socket is closed, or the socket is not configured to
793 this socket's lists.
796 @retval EFI_NOT_STARTED The socket is not configured.
802 IN SOCKET *Sock,
807 Issue a token with data to the socket to send out.
809 @param Sock Pointer to the socket to process the token with
814 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket, or the
815 socket is closed, or the socket is not in a
817 of this socket's lists.
820 @retval EFI_NOT_STARTED The socket is not configured.
826 IN SOCKET *Sock,
831 Issue a token to get data from the socket.
833 @param Sock Pointer to the socket to get data from.
835 socket.
838 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket, or the
839 socket is closed, or the socket is not in a
841 of this socket's lists.
844 @retval EFI_NOT_STARTED The socket is not configured.
851 IN SOCKET *Sock,
856 Reset the socket and its associated protocol control block.
858 @param Sock Pointer to the socket to be flushed.
860 @retval EFI_SUCCESS The socket is flushed successfully.
861 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket.
866 IN SOCKET *Sock
870 Close or abort the socket associated connection.
872 @param Sock Pointer to the socket of the connection to close or
879 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket, or the
880 socket is closed, or the socket is not in a
882 of this socket's lists.
885 @retval EFI_NOT_STARTED The socket is not configured.
890 IN SOCKET *Sock,
898 @param Sock Pointer to the socket to get mode data from.
903 @retval EFI_NOT_STARTED The socket is not configured.
908 IN SOCKET *Sock,
914 this socket's connection.
916 @param Sock Pointer to the socket of the connection to join the
921 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket.
922 @retval EFI_NOT_STARTED The socket is not configured.
927 IN SOCKET *Sock,
933 with this socket.
935 @param Sock Pointer to the socket associated with the IP route
940 @retval EFI_ACCESS_DENIED Failed to get the lock to access the socket.
943 @retval EFI_NOT_STARTED The socket is not configured.
948 IN SOCKET *Sock,
953 // Supporting function to operate on socket buffer
957 Get the first buffer block in the specific socket buffer.
959 @param Sockbuf Pointer to the socket buffer.
970 Get the next buffer block in the specific socket buffer.
972 @param Sockbuf Pointer to the socket buffer.
