BSD Socket

Provides functions for the socket related operations.

This module provides the socket related functions, such as open a socket, close a socket, bind a socket to an internet address, connect to the peer node, send and receive data from a peer node, etc.

The functions in this module provide similar capabilities as provided by BSD or POSIX socket API.

Refer to the documentation of each function for details.

Limitation

The parameter of flags in all the functions provided in this module is not used. The parameter of flags is a reserved parameter.

Group

Network Protocol

Functions

Function	Description
vm_soc_accept	Accepts a connection on a socket.
vm_soc_bind	Binds a local address with a socket.
vm_soc_close_socket	Closes the socket and release the resource.
vm_soc_connect	Connects a socket to a remote host.
vm_soc_get_account_localip	Gets the local IP held by the socket as specified.
vm_soc_getpeername	Retrieves the IP address and port number of the endpoint node.
vm_soc_getsockname	Retrieves the local IP address and port number.
vm_soc_getsockopt	Gets the socket options.
vm_soc_htonl	Converts long integer (32 bits) from host byte order to network byte order.
vm_soc_htons	Converts short integer (16 bits) from host byte order to network byte order
vm_soc_inet_addr	Converts the internet address in a dotted-decimal string notation into an internet network address in the IN_ADDR structure.
vm_soc_inet_ntoa	Converts an internet network address into a dotted-decimal string format.
vm_soc_inet_ntop	Converts an IPv4 or IPv6 address in its numeric binary form in network byte order into its standard text representation form. The format of 'x:x:x:x:x:x:d.d.d.d' is not supported.
vm_soc_inet_pton	Converts an IPv4 or IPv6 address in its standard text presentation form into its numeric binary form in network byte order. The format of 'x:x:x:x:x:x:d.d.d.d' is not supported.
vm_soc_listen	Makes the specified socket listen to the incoming connections.
vm_soc_recv	Receives data on a connected socket.
vm_soc_recvfrom	Receives data from the endpoint node.
vm_soc_select	Allows the application to query the status of multiple sockets. If timeout is null, vm_soc_select() will wait indefinitely until the first socket is ready. If both tv_sec and tv_msec are zero, vm_soc_select() will timeout immediately for polling the sockets in the set. in: If listen has been called and a connection is pending, accept will succeed. Data is available for reading (includes OOB data if VM_SOC_OOBINLINE is enabled). Connection has been closed/reset/terminated out: If processing a connect request (non-blocking mode), connection has succeeded. Data can be sent. ex: If processing a connect request (non-blocking mode), connection attempt failed. OOB data... more
vm_soc_send	Sends data on a connected socket.
vm_soc_sendto	Sends data to the endpoint node.
vm_soc_setsockopt	This function sets the socket options.
vm_soc_shutdown	Shutdowns the connection in specific side, such as reading side, writing side, or both. In a half read situation, vm_soc_shutdown() discards the received data that the application has not yet read and any further incoming data. In a half write situation of TCP, the remaining data will be sent first, then the FIN will be sent to close the connection.
vm_soc_socket	Creates a socket.
vm_soc_socket_ex	Creates a socket with a particular bearer, as specified by the data_account_id. In contrast, the vm_soc_socket() creates a socket with the latest opened bearer.

Macros

Macro	Description
accept	Refer to vm_accept.
AF_INET	IPv4.
bind	Refer to vm_bind.
closesocket	Refer to vm_closesocket.
connect	Refer to vm_connect.
fd_set	Sets the socket ID that you want to select.
FD_SET	Sets the socket ID that you want to select.
getpeername	Refer to vm_getpeername.
getsockname	Refer to vm_getsockname.
getsockopt	Refer to vm_getsockopt.
htonl	Refer to vm_htonl.
htons	Refer to vm_htons.
inet_addr	Refer to vm_inet_addr.
inet_ntoa	Refer to vm_inet_ntoa.
inet_ntop	Refer to vm_inet_ntop.
inet_pton	Refer to vm_inet_pton.
IPPROTO_HOPOPTS	IPv6 hop-by-hop options.
IPPROTO_ICMP	Internet Control Message Protocol. Currently, applications are only allowed to set this type when RAW_SOCKET is used
IPPROTO_IGMP	Internet Group Management Protocol.
IPPROTO_IP	Dummy for IP.
IPPROTO_IPIP	For compatibility.
IPPROTO_IPV4	IPv4 encapsulation.
IPPROTO_RAW	Raw IP packet.
IPPROTO_TCP	TCP protocol.
IPPROTO_UDP	User Datagram Protocol.
listen	Refer to vm_listen.
ntohl	Refer to vm_htonl.
ntohs	Refer to vm_htons.
PF_INET	IPv4.
PF_INET6	IPv6.
recv	Refer to vm_recv.
recvfrom	Refer to vm_recvfrom.
select	Refer to vm_select.
send	Refer to vm_send.
sendto	Refer to vm_sendto.
setsockopt	Refer to vm_setsockopt.
shutdowns	Refer to vm_shutdown.
SOCK_DGRAM	Datagram socket, UDP.
SOCK_STREAM	Stream socket, TCP.
socket	Refer to vm_socket.
socket_ex	Refer to vm_socket_ex.
VM_FD_SETSIZE	FD SET SIZE
VM_SOC_ADDRESS_MAX_LENGTH	The maximum length of the network socket address.

Structs, Records, Enums

Struct, Record, Enum	Description
in_addr	Generic IPv4 Address structure.
in6_addr	Generic IPv6 Address structure.
sockaddr	Generic Socket Address structure.
sockaddr_in	IPv4 Socket Address structure.
sockaddr_in6	IPv6 Socket Address structure.
IN_ADDR	Generic IPv4 Address structure.
IN6_ADDR	Generic IPv6 Address structure.
SOCKADDR	Generic Socket Address structure.
SOCKADDR_IN	IPv4 Socket Address structure.
SOCKADDR_IN6	IPv6 Socket Address structure.
timeval	Selects timeout structure.
vm_fd_set	Macros for SOC_SELECT
vm_soc_address_t	Socket address struct.
VM_SOC_OPTION	Socket Options
VM_SOC_RESULT	Socket return codes. The negative values stand for errors.
vm_soc_shutdown_enum	Shutdown(2), specified by Posix.1g.

Links

Topics, Functions, Macros, Structs, Records, Enums

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

support@toolsfactory.com.