bind

Asynchronous bind function associates the provided address and local port to the socket.

The function can be used with both TCP and UDP sockets. It is mandatory to call the bind function before starting any UDP or TCP server operation. Upon socket bind completion, the application will receive a SOCKET_MSG_BIND message in the socket callback.

Functions
NMI_API sint8	bind (SOCKET sock, struct sockaddr *pstrAddr, uint8 u8AddrLen)

NMI_API sint8 bind	(	SOCKET	sock,
		struct sockaddr *	pstrAddr,
		uint8	u8AddrLen
	)

Asynchronous bind function associates the provided address and local port to the socket.
The function can be used with both TCP and UDP sockets. It is mandatory to call the @ref bind function before starting any UDP or TCP server operation.
Upon socket bind completion, the application will receive a @ref SOCKET_MSG_BIND message in the socket callback.

Parameters

[in]	sock	Socket ID, must hold a non negative value. A negative value will return a socket error SOCK_ERR_INVALID_ARG. Indicating that an invalid argument is passed in.
[in]	pstrAddr	Pointer to socket address structure "sockaddr_in" sockaddr_in
[in]	u8AddrLen	Size of the given socket address structure in bytes.

Precondition

The socket function must be called to allocate a socket before passing the socket ID to the bind function.

See Also

socket

connect

listen

accept

recv

recvfrom

send

sendto

Returns

The function returns ZERO for successful operations and a negative value otherwise. The possible error values are:

• SOCK_ERR_NO_ERROR Indicating that the operation was successful.
• SOCK_ERR_INVALID_ARG Indicating passing invalid arguments such as negative socket ID or NULL socket address structure.
• SOCK_ERR_INVALID Indicate socket bind failure.

Example

This example demonstrates the call of the bind socket operation after a successful socket operation.

struct sockaddr_in  addr;
SOCKET udpServerSocket =-1;
int ret = -1;

if(udpServerSocket == -1)
{
    udpServerSocket = socket(AF_INET,SOCK_DGRAM,SOCKET_CONFIG_DEFAULT);
    if(udpServerSocket >= 0)
    {
        addr.sin_family     = AF_INET;
        addr.sin_port           = _htons(UDP_SERVER_PORT);
        addr.sin_addr.s_addr    = 0;
        ret = bind(udpServerSocket,(struct sockaddr*)&addr,sizeof(addr));

        if(ret == 0)
            printf("Bind success!\n");
        else
        {
            printf("Bind Failed. Error code = %d\n",ret);
            close(udpServerSocket);
    }
    else
    {
        printf("UDP Server Socket Creation Failed\n");
        return;
    }
}

Parameters

[in]	sock	Socket ID, must hold a non negative value. A negative value will return a socket error SOCK_ERR_INVALID_ARG. Indicating that an invalid argument is passed in.
[in]	pstrAddr	Pointer to socket address structure sockaddr_in.
[in]	u8AddrLen	Size of the given socket address structure in bytes.

Precondition

The socket function must be called to allocate a socket before passing the socket ID to the bind function.

See Also

socket

connect

listen

accept

recv

recvfrom

send

sendto

Returns

The function returns ZERO for successful operations and a negative value otherwise. The possible error values are:

• SOCK_ERR_NO_ERROR Indicating that the operation was successful.
• SOCK_ERR_INVALID_ARG Indicating passing invalid arguments such as negative socket ID or NULL socket address structure.
• SOCK_ERR_INVALID Indicate socket bind failure.

Example

This example demonstrates the call of the bind socket operation after a successful socket operation.

struct sockaddr_in  addr;
SOCKET udpServerSocket =-1;
int ret = -1;

if(udpServerSocket == -1)
{
    udpServerSocket = socket(AF_INET, SOCK_DGRAM, 0);
    if(udpServerSocket >= 0)
    {
        addr.sin_family         = AF_INET;
        addr.sin_port           = _htons(1234);
        addr.sin_addr.s_addr    = 0;
        ret = bind(udpServerSocket,(struct sockaddr*)&addr,sizeof(addr));

        if(ret != 0)
        {
            printf("Bind Failed. Error code = %d\n",ret);
            close(udpServerSocket);
        }
    }
    else
    {
        printf("UDP Server Socket Creation Failed\n");
        return;
    }
}

References m2m_memcpy(), MAX_SOCKET, NULL, tstrBindCmd::sock, SOCK_ERR_INVALID, SOCK_ERR_INVALID_ARG, SOCK_ERR_NO_ERROR, SOCKET_CMD_BIND, SOCKET_CMD_SSL_BIND, SOCKET_REQUEST, SSL_FLAGS_ACTIVE, tstrBindCmd::strAddr, tstrSockAddr::u16Family, tstrSockAddr::u16Port, tstrSocket::u16SessionID, tstrBindCmd::u16SessionID, and tstrSockAddr::u32IPAddr.

Referenced by IperfTCP_ServerStart(), IperfUDP_ServerStart(), main(), and wifi_ap_provision().