Macros for Assembler Programs

This section contains the description, syntax, parameters, and other related information for every macro included in this API.

ACCEPT
The ACCEPT macro is issued, if the server receives a connection request from a client.
BIND
In a server program, the BIND macro normally follows a SOCKET macro to complete the new socket creation process.
CANCEL
The CANCEL function terminates a call in progress.
CLOSE
The CLOSE macro shuts down the socket and frees the resources that are allocated to the socket.
CONNECT
The CONNECT macro is used by a client to establish a connection between a local socket and a remote socket.
FCNTL
The blocking mode for a socket can be queried or set to nonblocking using the FNDELAY flag.
FREEADDRINFO
The FREEADDRINFO macro frees all the address information structures returned by GETADDRINFO in the RES parameter.
GETADDRINFO
The GETADDRINFO macro translates the name of a service location (for example, a host name), a service name, or both, into a set of socket addresses and other associated information.
GETCLIENTID
The GETCLIENTID macro returns the identifier by which the calling application is known to the TCP/IP address space.
GETHOSTBYADDR
The GETHOSTBYADDR macro returns domain and alias names of the host whose internet address is specified by the macro.
GETHOSTBYNAME
The GETHOSTBYNAME macro returns the alias names and the internet addresses of a host whose domain name is specified in the macro.
GETHOSTID
The GETHOSTID macro returns the 32-bit identifier for the current host.
GETHOSTNAME
The GETHOSTNAME macro returns the name of the host processor on which the program is running.
GETIBMOPT
The GETIBMOPT macro returns the number of TCP/IP images installed on a given z/VSE system and the status, version, and name of each image.
GETNAMEINFO
The GETNAMEINFO macro returns the node name and service location of a socket address that is specified in the macro.
GETPEERNAME
The GETPEERNAME macro returns the name of the remote socket to which the local socket is connected.
GETSOCKNAME
The GETSOCKNAME macro stores the name of the socket into the structure pointed to by NAME and returns the address to the socket that has been bound.
GETSOCKOPT
GIVESOCKET
The GIVESOCKET macro makes the socket available for a TAKESOCKET macro issued by another program.
GSKFREEMEM
This function frees memory passed to the application on a previous call to an SSL function.
GSKGETCIPHINF
This function requests cipher related information for SSL for VSE.
GSKGETDNBYLAB
This function returns the complete distinguished name for a key based on the label the key has in the key database file.
GSKINIT
This function sets the overall SSL for VSE environment for the current partition.
GSKSSOCCLOSE
This function ends a secure socket connection and frees all SSL for VSE resources for that connection.
GSKSSOCINIT
This function initializes the data areas necessary for SSL for VSE to initiate or accept a secure socket connection.
GSKSSOCREAD
This function receives data on a secure socket connection.
GSKSSOCRESET
This function refreshes the security parameters, such as encryption keys, for a session.
GSKSSOCWRITE
This function sends data on a secure socket connection.
GSKUNINIT
The GSKUNINIT call removes the current overall settings for the SSL environment. It removes fields such as session timeout values and SSL protocols.
INITAPI
The INITAPI macro connects an application to the TCP/IP interface.
IOCTL
The IOCTL macro is used to control certain operating characteristics for a socket.
LISTEN
Only servers use the LISTEN macro.
NTOP
The NTOP macro converts an IP address from its numeric binary form into a standard text presentation form.
PTON
The PTON macro converts an IP address from its standard text presentation form to its numeric binary form.
READ
The READ macro reads data on a socket and stores it in a buffer.
READV
The READV macro reads data on a socket and stores it into a set of buffers.
RECV
The RECV macro receives data on a socket and stores it in a buffer.
RECVFROM
The RECVFROM macro receives data for a socket and stores it in a buffer.
SELECT
In a process where multiple I/O operations can occur it is necessary for the program to be able to wait on one or several of the operations to complete.
SELECTEX
The SELECTEX macro monitors a set of sockets, a time value, and an ECB or list of ECBs.
SEND
The SEND macro sends datagrams on a specified connected socket.
SENDTO
SENDTO is similar to SEND, except that it includes the destination address parameter.
SETSOCKOPT
The SETSOCKOPT macro sets the options associated with a socket.
SHUTDOWN
The SHUTDOWN macro can be used to close one-way traffic while completing data transfer in the other direction.
SOCKET
The SOCKET macro creates an endpoint for communication and returns a socket descriptor representing the endpoint.
TAKESOCKET
The TAKESOCKET macro acquires a socket from another program and creates a new socket.
TASK
The TASK macro allocates a task storage area addressable to all socket users within a task.
TERMAPI
The TERMAPI macro ends the session created by the INITAPI macro.
WRITE
The WRITE macro writes data on a connected socket. The WRITE macro is similar to the SEND macro.
WRITEV
The WRITEV macro writes data on a socket from a set of buffers.

Parent topic: Using the Macro Application Programming Interface (EZASMI API)