The extended spy library

Index

• SPY id
• Initialization
• Information retrieval
• Required files

SPY id

• SPY_ext_id

This is a primitive type so the access to the internal stucture should not be done.

All the routines of the library have a parameter of this type.

Initialization

The spy library can be used to extract information from a local circular buffer, from a circular buffer in a remote machine or from a YBOS file. Thou, three different initialization routines are needed:

• spy_open_CB
• spy_open_inet
• spy_open_ybos

On the other side, only one dispose function is needed: spy_close_ext. It uses the SPY id to distinguish between the three cases.

Follows the description of the functions:

spy_open_CB()

Opens a SPY id to a local circular buffer.

Syntax:

int spy_open_CB(char *keyname, SPY_ext_id *sid);

Parameters:

IN: keyname

Keyname of the local circular buffer

OUT: sid

the SPY id

Returns:

SPY_ERROR_OK in case of success

spy_open_inet()

Opens a SPY id to a remote circular buffer.

Syntax:

int spy_open_inet(char *raddr, int rport, SPY_ext_id *sid);

Parameters:

IN: raddr

address of the remote farm machine (can be a.b.c.d or 1.2.3.4)

IN: rport

port number of the remote farm spy daemon

OUT: sid

the SPY id

Returns:

SPY_ERROR_OK in case of success

spy_open_ybos()

Opens a SPY id to a YBOS file.

Syntax:

int spy_open_ybos(char *filename, SPY_ext_id *sid);

Parameters:

IN: filename

Path to the YBOS file

OUT: sid

the SPY id

Returns:

SPY_ERROR_OK in case of success

spy_close_ext()

Closes a previously opened SPY id.

Syntax:

int spy_close_ext(SPY_ext_id sid);

Parameters:

IN: sid

the SPY id to close

Returns:

SPY_ERROR_OK in case of success

Information retrieval

Syntax:

int spy_get_ext(SPY_ext_id sid, char **buf, int *bufsize);

Parameters:

IN: sid

a SPY id

OUT: buf

The pointer to the data, as in the buffer between farm builder and farm recorder.
Must be disposed by the caller

OUT: bufsize

The size of the data

Returns:

SPY_ERROR_OK in case of success
SPY_ERROR_EMPTY if no data available

Note:

Remember to dispose buf to prevent the memory leak problem

Required files