VxWorks Reference Manual : Libraries

wvFileUploadPathLib

NAME

wvFileUploadPathLib - file destination for event data

ROUTINES

fileUploadPathLibInit( ) - initialize the wvFileUploadPathLib library (Windview)
fileUploadPathCreate( ) - create a file for depositing event data (Windview)
fileUploadPathClose( ) - close the event-destination file (WindView)
fileUploadPathWrite( ) - write to the event-destination file (WindView)

DESCRIPTION

This file contains routines that write events to a file rather than uploading them to the host using a type of socket connection. If the file indicated is a TSFS file, this routine has the same result as uploading to a host file using other methods, allowing it to replace evtRecv. The file can be created anywhere, however, and event data can be kept on the target if desired.

INCLUDE FILES

SEE ALSO

wvFileUploadPathLib, wvSockUploadPathLib, wvTsfsUploadPathLib


Libraries : Routines

fileUploadPathLibInit( )

NAME

fileUploadPathLibInit( ) - initialize the wvFileUploadPathLib library (Windview)

SYNOPSIS


STATUS fileUploadPathLibInit (void)

DESCRIPTION

This routine initializes the library 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

wvFileUploadPathLib


Libraries : Routines

fileUploadPathCreate( )

NAME

fileUploadPathCreate( ) - create a file for depositing event data (Windview)

SYNOPSIS

UPLOAD_ID fileUploadPathCreate
    (
    char * fname,    /* name of file to create */
    int    openFlags /* O_CREAT, O_TRUNC */
    )

DESCRIPTION

This routine opens and initializes a file to receive uploaded events. The openFlags argument is passed on as the flags argument to the actual open call so that the caller can specify things like O_TRUNC and O_CREAT. The file is always opened as O_WRONLY, regardless of the value of openFlags.

RETURNS

The UPLOAD_ID, or NULL if the file can not be opened or memory for the ID is not available.

SEE ALSO

wvFileUploadPathLib, fileUploadPathClose( )


Libraries : Routines

fileUploadPathClose( )

NAME

fileUploadPathClose( ) - close the event-destination file (WindView)

SYNOPSIS

void fileUploadPathClose
    (
    UPLOAD_ID pathId /* generic upload-path descriptor */
    )

DESCRIPTION

This routine closes the file associated with pathId that is serving as a destination for event data.

RETURNS

N/A

SEE ALSO

wvFileUploadPathLib, fileUploadPathCreate( )


Libraries : Routines

fileUploadPathWrite( )

NAME

fileUploadPathWrite( ) - write to the event-destination file (WindView)

SYNOPSIS

int fileUploadPathWrite
    (
    UPLOAD_ID pathId, /* 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 file indicated by pathId.

RETURNS

The number of bytes written, or ERROR.

SEE ALSO

wvFileUploadPathLib