SOGetSockName

Syntax

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

int SOGetSockName(int fd, struct sockaddr *name, int *addrlen);

Parameters

fd Descriptor of socket from which the name is to be retrieved.
name Destination buffer into which the retrieved name will be placed.
addrlen Initialized with the length of the name; upon return will contain the actual length of the returned name.

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_ENOTSOCK Specified argument is not a socket.
SO_EINVAL Invalid operation occurred in the stack.
SO_ENOTCONN Not connected.
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

Retrieves the current name for the specified 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

SOBind
SOGetPeerName
SOSocket

Revision History

2012/08/16 Cleanup pass.
2011/07/11 Added Errors section.
2011/02/21 Initial version.


CONFIDENTIAL