VxWorks Reference Manual : Libraries

wvTsfsUploadPathLib

NAME

wvTsfsUploadPathLib - target host connection library using TSFS

ROUTINES

tsfsUploadPathLibInit( ) - initialize wvTsfsUploadPathLib library (Windview)
tsfsUploadPathCreate( ) - open an upload path to the host using a TSFS socket (Windview)
tsfsUploadPathClose( ) - close the TSFS-socket upload path (Windview)
tsfsUploadPathWrite( ) - write to the TSFS upload path (Windview)

DESCRIPTION

This library contains routines that are used by wvLib to transfer event data from the target to the host. This transfer mechanism uses the socket functionality of the Target Server File System (TSFS), and can therefore be used without including any socket or network facilities within the target.

INCLUDE FILES

SEE ALSO

wvTsfsUploadPathLib, wvSockUploadPathLib, wvFileUploadPathLib


Libraries : Routines

tsfsUploadPathLibInit( )

NAME

tsfsUploadPathLibInit( ) - initialize wvTsfsUploadPathLib library (Windview)

SYNOPSIS


STATUS tsfsUploadPathLibInit (void)

DESCRIPTION

This routine initializes wvTsfsUploadPathLib by pulling in the routines in this file for use with WindView. It is called during system configuration from usrWindview.c.

RETURNS

OK.

SEE ALSO

wvTsfsUploadPathLib


Libraries : Routines

tsfsUploadPathCreate( )

NAME

tsfsUploadPathCreate( ) - open an upload path to the host using a TSFS socket (Windview)

SYNOPSIS

UPLOAD_ID tsfsUploadPathCreate
    (
    char * ipAddress, /* server's IP address in .-notation */
    short  port       /* port number to bind to */
    )

DESCRIPTION

This routine opens a TSFS socket to the host to be used for uploading event data. After successfully establishing this connection, an UPLOAD_ID is returned which points to the TSFS_UPLOAD_DESC that is passed to open( ), close( ), read( ), etc. for future operations.

RETURNS

The UPLOAD_ID, or NULL if the connection cannot be completed or not enough memory is available.

SEE ALSO

wvTsfsUploadPathLib, tsfsUploadPathClose( )


Libraries : Routines

tsfsUploadPathClose( )

NAME

tsfsUploadPathClose( ) - close the TSFS-socket upload path (Windview)

SYNOPSIS

void tsfsUploadPathClose
    (
    UPLOAD_ID upId /* generic upload-path descriptor */
    )

DESCRIPTION

This routine closes the TSFS-socket connection to the event receiver on the host.

RETURNS

N/A

SEE ALSO

wvTsfsUploadPathLib, tsfsUploadPathCreate( )


Libraries : Routines

tsfsUploadPathWrite( )

NAME

tsfsUploadPathWrite( ) - write to the TSFS upload path (Windview)

SYNOPSIS

int tsfsUploadPathWrite
    (
    UPLOAD_ID upId,   /* generic upload-path descriptor */
    char *    pStart, /* address of data to write */
    size_t    size    /* number of bytes of data at pStart */
    )

DESCRIPTION

This routine writes size bytes of data beginning at pStart to the upload path connecting the target with the host receiver.

RETURNS

The number of bytes written, or ERROR.

SEE ALSO

wvTsfsUploadPathLib, tsfsUploadPathCreate( )