TCP

The TCP API is for creating TCP clients / TCP servers and it supports synchronous and asynchronous methods.

Using the asynchronous functions, the application will register a callback function and will not block the current process until the result is obtained. When the result is received, the callback function will be called with the specified event.

Using the synchronous functions, the application will block the current process until the result is received, even if the operation takes a long time.

Limitation

There is a maximum of 3 concurrent connections.

Group

Network Protocol

Functions

Function	Description
vm_tcp_close	This function closes a TCP connection.
vm_tcp_close_sync	This function closes an open TCP connection synchronously and it will be blocked until it has finished closing the connections.
vm_tcp_connect	This function creates a TCP connection to the host.
vm_tcp_connect_sync	This function creates a TCP connection synchronously and it will be blocked until it is connected.
vm_tcp_read	This function reads data from a TCP connection.
vm_tcp_read_sync	This function reads data from a TCP connection synchronously and it will blocked until it has finished reading all data.
vm_tcp_server_accept_sync	This function waits for the incoming connections and returns a new connection socket handle.
vm_tcp_server_close_client	This function represents the server that closes the client.
vm_tcp_server_close_client_sync	This function closes the client socket synchronously.
vm_tcp_server_init	This function initiates a server socket.
vm_tcp_server_init_sync	This function initiates socket server synchronously.
vm_tcp_server_read	This function represents the server that reads data received by a client.
vm_tcp_server_read_sync	This function reads data synchronously.
vm_tcp_server_release	This function de-initializes the socket server.
vm_tcp_server_release_sync	This function de-initiates socket server synchronously.
vm_tcp_server_write	This function sends data from a server to a client.
vm_tcp_server_write_sync	This function sends data to a host which was previously connected.
vm_tcp_write	This function writes data to TCP connection.
vm_tcp_write_sync	This function writes data to an open TCP connection synchronously and it will be blocked until it has finished writing all data.

Structs, Records, Enums

Struct, Record, Enum	Description
VM_TCP_EVENT	TCP events
VM_TCP_RESULT	TCP results

Types

Type	Description
vm_tcp_connect_callback	This function represents TCP connection callback function type.
vm_tcp_server_callback	This is the Callback function type of TCP server.

Links

Topics, Functions, Structs, Records, Enums, Types

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.