VxWorks Reference Manual : Libraries

wvSockUploadPathLib

NAME

wvSockUploadPathLib - socket upload path library

ROUTINES

sockUploadPathLibInit( ) - initialize wvSockUploadPathLib library (Windview)
sockUploadPathCreate( ) - establish an upload path to the host using a socket (Windview)
sockUploadPathClose( ) - close the socket upload path (Windview)
sockUploadPathWrite( ) - write to the socket upload path (Windview)

DESCRIPTION

This file contains routines that are used by wvLib to pass event data from the target buffers to the host. This particular event-upload path opens a normal network socket connected with the WindView host process to transfer the data.

INCLUDE FILES

SEE ALSO

wvSockUploadPathLib, wvTsfsUploadPathLib, wvFileUploadPathLib


Libraries : Routines

sockUploadPathLibInit( )

NAME

sockUploadPathLibInit( ) - initialize wvSockUploadPathLib library (Windview)

SYNOPSIS


STATUS sockUploadPathLibInit (void)

DESCRIPTION

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

RETURN

OK.

SEE ALSO

wvSockUploadPathLib


Libraries : Routines

sockUploadPathCreate( )

NAME

sockUploadPathCreate( ) - establish an upload path to the host using a socket (Windview)

SYNOPSIS

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

DESCRIPTION

This routine initializes the TCP/IP connection to the host process that receives uploaded events. It can be retried if the connection attempt fails.

RETURNS

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

SEE ALSO

wvSockUploadPathLib, sockUploadPathClose( )


Libraries : Routines

sockUploadPathClose( )

NAME

sockUploadPathClose( ) - close the socket upload path (Windview)

SYNOPSIS

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

DESCRIPTION

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

RETURNS

N/A

SEE ALSO

wvSockUploadPathLib, sockUploadPathCreate( )


Libraries : Routines

sockUploadPathWrite( )

NAME

sockUploadPathWrite( ) - write to the socket upload path (Windview)

SYNOPSIS

int sockUploadPathWrite
    (
    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 between the target and the event receiver on the host.

RETURNS

The number of bytes written, or ERROR.

SEE ALSO

wvSockUploadPathLib, sockUploadPathCreate( )