xref: /titanic_50/usr/src/man/man3xnet/bind.3xnet (revision b0e753dd6a955fb2f10a0ce17d32bd33172e0400)
te
Copyright (c) 1997, The Open Group. All Rights Reserved.
Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
BIND 3XNET "Feb 20, 2003"
NAME
bind - bind a name to a socket
SYNOPSIS

cc [ flag ... ] file ... -lxnet [ library ... ]
#include <sys/socket.h>

int bind(int socket, const struct sockaddr *address,
 socklen_t address_len);
DESCRIPTION

The bind() function assigns an address to an unnamed socket. Sockets created with socket(3XNET) function are initially unnamed. They are identified only by their address family.

The function takes the following arguments: socket

Specifies the file descriptor of the socket to be bound.

address

Points to a sockaddr structure containing the address to be bound to the socket. The length and format of the address depend on the address family of the socket.

address_len

Specifies the length of the sockaddr structure pointed to by the address argument.

The socket in use may require the process to have appropriate privileges to use the bind() function.

USAGE

An application program can retrieve the assigned socket name with the getsockname(3XNET) function.

RETURN VALUES

Upon successful completion, bind() returns 0. Otherwise, -1 is returned and errno is set to indicate the error.

ERRORS

The bind() function will fail if: EADDRINUSE

The specified address is already in use.

EADDRNOTAVAIL

The specified address is not available from the local machine.

EAFNOSUPPORT

The specified address is not a valid address for the address family of the specified socket.

EBADF

The socket argument is not a valid file descriptor.

EFAULT

The address argument can not be accessed.

EINVAL

The socket is already bound to an address, and the protocol does not support binding to a new address; or the socket has been shut down.

ENOTSOCK

The socket argument does not refer to a socket.

EOPNOTSUPP

The socket type of the specified socket does not support binding to an address.

If the address family of the socket is AF_UNIX, then bind() will fail if: EACCES

A component of the path prefix denies search permission, or the requested name requires writing in a directory with a mode that denies write permission.

EDESTADDRREQ

EISDIR

The address argument is a null pointer.

EIO

An I/O error occurred.

ELOOP

Too many symbolic links were encountered in translating the pathname in address.

ENAMETOOLONG

A component of a pathname exceeded NAME_MAX characters, or an entire pathname exceeded PATH_MAX characters.

ENOENT

A component of the pathname does not name an existing file or the pathname is an empty string.

ENOTDIR

A component of the path prefix of the pathname in address is not a directory.

EROFS

The name would reside on a read-only filesystem.

The bind() function may fail if: EACCES

The specified address is protected, and {PRIV_NET_PRIVADOR} is not asserted in the effective set of the current process.

EINVAL

The address_len argument is not a valid length for the address family.

EISCONN

The socket is already connected.

ENAMETOOLONG

Pathname resolution of a symbolic link produced an intermediate result whose length exceeds PATH_MAX.

ENOBUFS

Insufficient resources were available to complete the call.

ENOSR

There were insufficient STREAMS resources for the operation to complete.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

sockaddr(3SOCKET), connect(3XNET), getsockname(3XNET), listen(3XNET), socket(3XNET), attributes(5), privileges(5), standards(5)