TABLE OF CONTENTS
- 1. libram-record/libram-record
- 2. libram-record/libramrecord
- 3. libram-record/libramrecord_close
- 4. libram-record/libramrecord_data
- 5. libram-record/libramrecord_exit
- 6. libram-record/libramrecord_fd
- 7. libram-record/libramrecord_free
- 8. libram-record/libramrecord_init
- 9. libram-record/libramrecord_open
- 10. libram-record/libramrecord_process
- 11. libram-record/libramrecord_result
- 12. libram-record/libramrecord_wait
libram-record/libram-record [ Generics ]
[ Top ] [ libram-record ] [ Generics ]
NAME
libram-record - record backend to libram
DESCRIPTION
libram-record is a backend module for libram, that records all incoming data to a file.
The connection string for libram-record module consists of:
- file: the output file to which the recorded data is written.
- start: If this option is set, it sets the start time to the given value, The time value is incremented for each request. If this option is not set, the current time is recorded. This option is inteded for test purposes.
SEE ALSO
libram(3), libramrecord(3), libram_init(3)
libram-record/libramrecord [ Variables ]
[ Top ] [ libram-record ] [ Variables ]
NAME
libramrecord - libram_module structure for libram-record module
DESCRIPTION
This variable define the libram_module(3) structure of the libram-record(3) module.
SOURCE
struct libram_module libramrecord = { "record", NULL, libramrecord_init, libramrecord_exit, libramrecord_open, libramrecord_data, libramrecord_close, libramrecord_fd, libramrecord_process, libramrecord_wait, libramrecord_free, };
SEE ALSO
libram(3), libram_module(3), libram-record(3)
libram-record/libramrecord_close [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_close - libram_close function for libram-record
SYNOPSIS
struct reply *libramrecord_close(ram_bh bh, int flags, long id, conn_payloadp d)
DESCRIPTION
libramrecord_close implements the libram_close function for the libram-record module.
ARGUMENTS
- bh: backend handle returned by libramrecord_init(3)
- flags: flags passed from libram_close(), see libram_flags(3)
- id: connection id
- d: connection data
RETURN
- NULL: flags contain LIBRAM_DISCARD_RESULT or malloc failure
- != NULL: result with libram_action_pass
SEE ALSO
libramrecord_init(3), libramrecord_exit(3), libramrecord_open(3), libramrecord_data(3), ram_bh(3), conn_payload(3), libram_flags(3)
libram-record/libramrecord_data [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_data - libram_data function for libram-record
SYNOPSIS
struct reply *libramrecord_data(ram_bh bh, int flags, long id, conn_payload* d)
DESCRIPTION
libramrecord_data implements the libram_data function for the libram-record module.
It returns libram_action_pass or NULL if flags contain LIBRAM_DISCARD_RESULT.
ARGUMENTS
- bh: backend handle returned by libramrecord_init(3)
- flags: flags passed from libram_open(), see libram_flags(3)
- id: connection id
- d: connection data
RETURN
- NULL: flags contain LIBRAM_DISCARD_RESULT or malloc failure
- != NULL: result structure with libram_action_pass
SEE ALSO
libramrecord_init(3), libramrecord_exit(3), ram_bh(3), conn_payload(3), libram_flags(3)
libram-record/libramrecord_exit [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_exit - libram_exit function for libram-record
SYNOPSIS
int libramrecord_exit(ram_bh bh)
DESCRIPTION
libramrecord_exit implements the libram_exit function for the libram-record module. It closes the onc/rpc connection opend with libramrecord_init(3)
ARGUMENTS
- bh: backend handle returned by libramrecord_init(3)
RETURN
0
SEE ALSO
libram-record/libramrecord_fd [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_fd - get filedescriptor used by libramrecord
SYNOPSIS
int libramrecord_fd(ram_bh bh)
DESCRIPTION
libramrecord_fd is used to get the file descriptor used internally in libram-record. No filedescriptor is used and libramrecord_fd() return -1.
Handling of asynchronous calls is handled within libram(3).
ARGUMENTS
- bh: handle to backend module
RETURN
- -1: no file descriptor available
SEE ALSO
libram-record(3), libramrecord_process(3), libramrecord_wait(3), libram(3)
libram-record/libramrecord_free [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_free - free reply strucutre from libram_process and libram_wait
SYNOPSIS
void libramrecord_free(ram_bh bh, struct reply *res)
DESCRIPTION
libramrecord_free frees the memory allocated with libramrecord_process or libramrecord_wait.
ARGUMENTS
- bh: handle to backend module
- res: pointer to reply structure
SEE ALSO
libram-record(3), libramrecord_process(3), libramrecord_fd(3), libramrecord_wait(3), libram(3)
libram-record/libramrecord_init [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_init - libram_init function for libram-record
SYNOPSIS
ram_bh libramrecord_init(char *connect, int *flags)
DESCRIPTION
libramrecord_init implements the libram_init function for the libram-record module. See libram_init(3) for a general description of the connect and flags parameter. See libram-record(3) for the description of the connect and flag parameters specific for the libram-record(3) module.
ARGUMENTS
- connect: connect string.
- flags: flags to backend module
RETURN
- NULL: error
- backend_handle of type libramrecord_bh
NOTES
connect is parsed with strtok(3). strtok(3) alters the string and adds null characters to the string.
SEE ALSO
libram-record(3), libram(3), libram_init(3), strtok(3), ramrecord_bh(3)
libram-record/libramrecord_open [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_open - libram_open function for libram-record
SYNOPSIS
struct reply *libramrecord_open(ram_bh bh, int flags, long id, conn_hdr* hdr, conn_payload* d)
DESCRIPTION
libramrecord_open implements the libram_open function for the libram-record module.
It returns libram_action_pass or NULL if flags contain LIBRAM_DISCARD_RESULT.
ARGUMENTS
- bh: backend handle returned by libramrecord_init(3)
- flags: flags passed from libram_open(), see libram_flags(3)
- id: connection id
- hdr: connection header of data
- d: connection data
RETURN
- NULL: flags contain LIBRAM_DISCARD_RESULT or malloc failure
- != NULL: result structure with libram_action_pass
SEE ALSO
libramrecord_init(3), libramrecord_exit(3), ram_bh(3), conn_hdr(3), conn_payload(3)
libram-record/libramrecord_process [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_process - process input on libramrecord file descriptor
SYNOPSIS
struct reply *libramrecord_process(ram_bh bh, fd_set *fds)
DESCRIPTION
libramrecord_process handles input on the libramrecord file descriptor.
Since libram-record is a synchronous module, it just returns NULL.
Handling of asynchronous calls is handled within libram(3).
ARGUMENTS
- bh: handle to backend module
- fds: pointer to fd_set structure.
RETURN
- NULL: no data available
SEE ALSO
libram-record(3), libramrecord_fd(3), libramrecord_wait(3), libram(3)
libram-record/libramrecord_result [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_result - result postprecessing for libramrecord callbacks
SYNOPSIS
struct reply * libramrecord_result(ram_bh bh, int flags, long id)
DESCRIPTION
libramrecord_result does postprocessing for libramrecord callbacks. The postprocessing includes:
- all libramdeny callbacks return the libram_action_pass return code if LIBRAM_DISCARD_RESULT is not set within the flags. libram_result allocates a return structure, fills in the return code an returns the reply structure to the caller.
ARGUMENTS
- bh: backend handle returned by libramrecord_init(3)
- flags: flags passed to libramrecord_result(), see libram_flags(3)
- id: connection id
RETURN
- NULL: flags contain LIBRAM_DISCARD_RESULT or malloc failure
- != NULL: result structure with libram_action_pass
SEE ALSO
libramrecord_init(3), libramrecord_exit(3), ram_bh(3), libramrecord_open(3), libramrecord_data(3), libramrecord_close(3), libramrecord_wait(3), libramrecord_process(3), libramrecord_free(3), libram_flags(3)
libram-record/libramrecord_wait [ Functions ]
[ Top ] [ libram-record ] [ Functions ]
NAME
libramrecord_wait - wait for answer from libramrecord call
SYNOPSIS
struct reply *libramrecord_wait(ram_bh bh, int timeout)
DESCRIPTION
libramrecord_wait waits for an anser from a libramrecord remote procedure call.
Since libram-record is a synchronous module, it just returns NULL.
Handling of asynchronous calls is handled within libram(3).
ARGUMENTS
- bh: handle to backend module
- timeout: timeout waiting for reply
RETURN
- NULL: no data available
NOTES
The timeout is used for each select(3) call. This it gives no upper limit for the timeout in libramrecord_wait(3)
SEE ALSO
libram-record(3), libramrecord_process(3), libramrecord_fd(3), libram(3)