20182018 Ericsson AB. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. socket socket.xml
socket Socket interface.

This module provides an API for the socket interface. It is used to create, delete and manipulate sockets.

 socket()

As returned by open/2,3,4 and accept/1,2.

 Accept a connection on a socket.

Accept a connection on a socket.

This call is used with connection-based socket types (stream or seqpacket). It extracs the first pending connection request for the listen socket and returns the (newly) connected socket.

 Bind a name to a socket.

Bind a name to a socket.

When a socket is created (with open), it has no address assigned to it. bind assigns the address specified by the Addr argument.

The rules used for name binding vary between domains.

 Close a socket.

Closes the socket.

 Initiate a connection on a socket.

This function connects the socket to the address specied by the Addr argument.

 Get an option on a socket.

Get an option on a socket.

What properties are valid depend on what kind of socket it is (domain, type and protocol).

When specifying Level as an integer, and therefor using "native mode", it is *currently* up to the caller to know how to interpret the result.

Not all options are valid on all platforms. That is, even if "we" support an option, that does not mean that the underlying OS does.

 Listen for connections on a socket.

Listen for connections on a socket.

 Create an endpoint for communication.

Creates an endpoint (socket) for communication.

For some types there is a default protocol, which will be used if no protocol is specified:

stream: tcp

dgram: udp

seqpacket: sctp

The Extra argument is intended for "obscure" options. Currently the only supported option is netns, which is only supported on the linux platform.

 Receive a message from a socket.

Receive a message from a socket.

There is a special case for the argument Length. If it is set to zero (0), it means "give me everything you currently have".

 Receive a message from a socket.

Receive a message from a socket.

This function reads "messages", which means that regardless of how much we want to read, it returns when we get a message.

The MaxSize argument basically defines the size of the receive buffer. By setting the value to zero (0), the configured size (setopt) is used.

It may be impossible to know what (buffer) size is appropriate "in advance", and in those cases it may be convenient to use the (recv) 'peek' flag. When this flag is provided the message is *not* "consumed" from the underlying buffers, so another recvfrom call is needed, possibly with a then adjusted buffer size.

 Send a message on a socket.

Send a message on a connected socket.

 Send a message on a socket.

Send a message on a socket, to the specified destination.

 Set options on a socket.

Set options on a socket.

What properties are valid depend both on Level and on what kind of socket it is (domain, type and protocol).

Not all options are valid on all platforms. That is, even if "we" support an option, that does not mean that the underlying OS does.

Sockets are set 'non-blocking' when created, so this option is *not* available (as it would adversely effect the Erlang VM to set a socket 'blocking').

 Shut down part of a full-duplex connection.

Shut down all or part of a full-duplex connection.