SOBind

Syntax

#include <cafe.h>
#include <cafe/network.h>

int SOBind(int fd, struct sockaddr *addr, int addrlen);

Parameters

fd Descriptor of socket to bind.
addr Pointer to address structure containing address to assign the given socket.
addrlen Length of address structure in bytes.

Return Values

0 upon success. Upon failure, -1 is returned and errno is set appropriately.

Errors

SO_ELIBNOTREADY Socket library is not initialized.
SO_ENOMEM Insufficient memory in the stack.
SO_EINVAL Specified argument is invalid.
SO_ENOTSOCK The argument fd does not refer to a socket.
SO_EADDRNOTAVAIL The specified address is not available from the local machine.
SO_EADDRINUSE The specified address is already in use.
SO_EBUSY Socket resource manager busy processing requests.
SO_EABORTED Indicates the operation was aborted. For example, this error can be returned for calls blocked on a socket after the socket is closed by another thread.
SO_EUNKNOWN Unknown error.
SO_ERANGEINVALID Internal API error, invalid error code.
SO_EAPIERROR Internal API error.

Description

Binds a name (address) to a socket. When a socket is created with SOSocket it exists in a name space (address family) but has no name assigned. SOBind requests that the name pointed to by addr be assigned to the socket.

Do Not Call From

Callbacks Do not call this function from any callback function.
Interrupt handler Do not call this function from any interrupt handler.
Exception handler Do not call this function from any exception handler.

See Also

SOAccept
SOConnect
SOListen
SOSocket

Revision History

2012/10/09 Updated Errors section.
2012/08/17 Cleanup pass.
2011/07/11 Added Errors section.
2011/02/21 Initial version.


CONFIDENTIAL