summaryrefslogtreecommitdiff
path: root/common/src/nxe_tcp_socket_state_wait.c
diff options
context:
space:
mode:
authorPProvost <[email protected]>2020-05-11 08:54:23 -0600
committerPProvost <[email protected]>2020-05-11 08:54:23 -0600
commit0c4f784459a7564933ed91bf39f00d12608cf91c (patch)
treecfa743731d1cfb11d83119bf1c8d0d942e8c3c73 /common/src/nxe_tcp_socket_state_wait.c
Initial commit
Diffstat (limited to 'common/src/nxe_tcp_socket_state_wait.c')
-rw-r--r--common/src/nxe_tcp_socket_state_wait.c111
1 files changed, 111 insertions, 0 deletions
diff --git a/common/src/nxe_tcp_socket_state_wait.c b/common/src/nxe_tcp_socket_state_wait.c
new file mode 100644
index 00000000..f65f8a14
--- /dev/null
+++ b/common/src/nxe_tcp_socket_state_wait.c
@@ -0,0 +1,111 @@
+/**************************************************************************/
+/* */
+/* Copyright (c) Microsoft Corporation. All rights reserved. */
+/* */
+/* This software is licensed under the Microsoft Software License */
+/* Terms for Microsoft Azure RTOS. Full text of the license can be */
+/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
+/* and in the root directory of this software. */
+/* */
+/**************************************************************************/
+
+
+/**************************************************************************/
+/**************************************************************************/
+/** */
+/** NetX Component */
+/** */
+/** Transmission Control Protocol (TCP) */
+/** */
+/**************************************************************************/
+/**************************************************************************/
+
+#define NX_SOURCE_CODE
+
+
+/* Include necessary system files. */
+
+#include "nx_api.h"
+#include "nx_tcp.h"
+
+
+/* Bring in externs for caller checking code. */
+
+NX_CALLER_CHECKING_EXTERNS
+
+
+/**************************************************************************/
+/* */
+/* FUNCTION RELEASE */
+/* */
+/* _nxe_tcp_socket_state_wait PORTABLE C */
+/* 6.0 */
+/* AUTHOR */
+/* */
+/* Yuxin Zhou, Microsoft Corporation */
+/* */
+/* DESCRIPTION */
+/* */
+/* This function checks for errors in the socket state wait */
+/* function call. */
+/* */
+/* INPUT */
+/* */
+/* socket_ptr Pointer to socket */
+/* desired_state Desired TCP state */
+/* wait_option Suspension option */
+/* */
+/* OUTPUT */
+/* */
+/* status Completion status */
+/* */
+/* CALLS */
+/* */
+/* _nx_tcp_socket_state_wait Actual socket state wait */
+/* function */
+/* */
+/* CALLED BY */
+/* */
+/* Application */
+/* */
+/* RELEASE HISTORY */
+/* */
+/* DATE NAME DESCRIPTION */
+/* */
+/* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
+/* */
+/**************************************************************************/
+UINT _nxe_tcp_socket_state_wait(NX_TCP_SOCKET *socket_ptr, UINT desired_state, ULONG wait_option)
+{
+
+UINT status;
+
+
+ /* Check for invalid input pointers. */
+ if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID))
+ {
+ return(NX_PTR_ERROR);
+ }
+
+ /* Check to see if TCP is enabled. */
+ if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive)
+ {
+ return(NX_NOT_ENABLED);
+ }
+
+ /* Check for an invalid state request. */
+ if ((desired_state < NX_TCP_CLOSED) || (desired_state > NX_TCP_LAST_ACK))
+ {
+ return(NX_OPTION_ERROR);
+ }
+
+ /* Check for appropriate caller. */
+ NX_THREADS_ONLY_CALLER_CHECKING
+
+ /* Call actual TCP socket state wait function. */
+ status = _nx_tcp_socket_state_wait(socket_ptr, desired_state, wait_option);
+
+ /* Return completion status. */
+ return(status);
+}
+