rtxNetUtil.h File Reference

#include "rtxsrc/rtxContext.h"
#include "rtxsrc/rtxSocket.h"

Go to the source code of this file.

Functions

EXTERNRT OSRTNETCONN * rtxNetCreateConn (OSCTXT *pctxt, const char *url)
 This function creates a new network connection to the given URL.
EXTERNRT int rtxNetCloseConn (OSRTNETCONN *pNetConn)
 This function closes a network connection.
EXTERNRT int rtxNetConnect (OSRTNETCONN *pNetConn)
 This function creates a network connection.

Detailed Description

Definition in file rtxNetUtil.h.


Function Documentation

EXTERNRT int rtxNetCloseConn ( OSRTNETCONN *  pNetConn  ) 

This function closes a network connection.

Parameters:
pNetConn - Pointer to network connection structure. This is assumed to have been created using the rtxNetCreateNewConn.
Returns:
- Operation status: 0 if success, negative code if error.
EXTERNRT int rtxNetConnect ( OSRTNETCONN *  pNetConn  ) 

This function creates a network connection.

The network entity is described by a network connection structure. The network structure may have been created from a URL using the rtxNetCreateConn function or may have been initialized manually.

Parameters:
pNetConn - Pointer to network connection structure.
Returns:
- Operation status: 0 if success, negative code if error.
See also:
rtxNetCreateConn
EXTERNRT OSRTNETCONN* rtxNetCreateConn ( OSCTXT pctxt,
const char *  url 
)

This function creates a new network connection to the given URL.

Parameters:
pctxt - Pointer to run-time context structure.
url - URL to which to connect.
Returns:
- Pointer to allocated network connection object or null if error. If error, error information is stored in context variable and can be accessed using rtxErr* functions. Allocated memory will be freed when rtxNetCloseConn is called.