BRL.Socket: | Functions | Source |
CreateUDPSocket | Create a UDP socket |
CreateTCPSocket | Create a TCP socket |
CloseSocket | Close a socket |
BindSocket | Bind a socket to a local port |
ConnectSocket | Connect a socket to a remote ip and port |
SocketListen | Start listening at a socket |
SocketAccept | Accept new connections on a listening socket |
SocketConnected | Get socket connection status |
SocketReadAvail | Get number of bytes available for reading from a socket |
SocketLocalIP | Get local ip of a socket |
SocketLocalPort | Get local port of a socket |
SocketRemoteIP | Get remote ip of a socket |
SocketRemotePort | Get remote port of a socket |
DottedIP | Convert an ip address to a dotted string |
HostIp | Convert a host name to an ip address |
HostIps | Get all ip addresses for a host name |
HostName | Convert a host ip address to a name |
Function CreateUDPSocket:TSocket() | |
Returns | A new socket |
Description | Create a UDP socket |
Information | The new socket is not bound to any local or remote address. |
Function CreateTCPSocket:TSocket() | |
Returns | A new socket |
Description | Create a TCP socket |
Information | The new socket is not bound to any local or remote address. |
Function CloseSocket( socket:TSocket ) | |
Description | Close a socket |
Information | All sockets should eventually be closed. Once closed, a socket can no longer be used. |
Function BindSocket( socket:TSocket,localPort ) | |
Returns | True if successful, otherwise false |
Description | Bind a socket to a local port |
Information | If localPort is 0, a new local port will be allocated. If localPort is not 0, BindSocket will fail if there is already an application bound to localPort. |
Function ConnectSocket( socket:TSocket,remoteIp,remotePort ) | |
Returns | True if successful, otherwise false |
Description | Connect a socket to a remote ip and port |
Information |
For both UDP and TCP sockets, ConnectSocket will fail if the specified
ip address could not be reached.
In the case of TCP sockets, ConnectSocket will also fail if there is no application listening at the remote port. |
Function SocketListen( socket:TSocket,backlog=0 ) | |
Description | Start listening at a socket |
Information | The specified socket must be a TCP socket, and must already be bound to a local port. |
Function SocketAccept:TSocket( socket:TSocket,timeout=0 ) | |
Returns | A new socket, or Null if no connection was made in the specified timeout |
Description | Accept new connections on a listening socket |
Information | The specified socket must be a TCP socket, and must be listening. |
Function SocketConnected( socket:TSocket ) | |
Returns | True if socket is connected |
Description | Get socket connection status |
Information |
SocketConnected allows you to determine if a TCP connection is still
alive or has been remotely closed.
SocketConnected should only be used with TCP sockets that have already connected via ConnectSocket or SocketAccept. |
Function SocketReadAvail( socket:TSocket ) | |
Returns | Number of bytes that may be read without causing the socket to block |
Description | Get number of bytes available for reading from a socket |
Function SocketLocalIP( socket:TSocket ) | |
Description | Get local ip of a socket |
Function SocketLocalPort( socket:TSocket ) | |
Description | Get local port of a socket |
Function SocketRemoteIP( socket:TSocket ) | |
Description | Get remote ip of a socket |
Function SocketRemotePort( socket:TSocket ) | |
Description | Get remote port of a socket |
Function DottedIP$( ip ) | |
Returns | Dotted string version of ip address |
Description | Convert an ip address to a dotted string |
Function HostIp( HostName$,index=0 ) | |
Returns | Host ip address, or 0 if host not found |
Description | Convert a host name to an ip address |
Function HostIps:Int[]( HostName$ ) | |
Returns | Array of host ips, or Null if host not found |
Description | Get all ip addresses for a host name |
Function HostName$( HostIp ) | |
Returns | Name of host, or Null if host not found |
Description | Convert a host ip address to a name |