libram API

Table of Contents Sourcefiles index Generics Functions Structures Variables

TABLE OF CONTENTS

• 1. libram-accept/libram-accept
• 1.1. libram-accept/libramaccept
• 1.2. libram-accept/libramaccept_close
• 1.3. libram-accept/libramaccept_data
• 1.4. libram-accept/libramaccept_exit
• 1.5. libram-accept/libramaccept_fd
• 1.6. libram-accept/libramaccept_free
• 1.7. libram-accept/libramaccept_init
• 1.8. libram-accept/libramaccept_open
• 1.9. libram-accept/libramaccept_process
• 1.10. libram-accept/libramaccept_result
• 1.11. libram-accept/libramaccept_wait
• 1.12. libram-accept/ramaccept_bh

---

libram-accept/libram-accept [ Generics ]

[ Top ] [ Generics ]

NAME

libram-accept - accept backend to libram

DESCRIPTION

libram-accept is a backend module for libram, that accepts all incoming requests.

libram-accept has configure no options and does not need a connect string.

SEE ALSO

libram(3), libramaccept(3), libram_init(3)

---

libram-accept/libramaccept [ Variables ]

[ Top ] [ libram-accept ] [ Variables ]

NAME

libramaccept - libram_module structure for libram-accept module

DESCRIPTION

This variable define the libram_module(3) structure of the libram-accept(3) module.

SOURCE

struct libram_module libramaccept = {
        "accept",
        NULL,

        libramaccept_init,
        libramaccept_exit,

        libramaccept_open,
        libramaccept_data,
        libramaccept_close,

        libramaccept_fd,
        libramaccept_process,
        libramaccept_wait,
        libramaccept_free,
};

SEE ALSO

libram(3), libram_module(3), libram-accept(3)

---

libram-accept/libramaccept_close [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_close - libram_close function for libram-accept

SYNOPSIS

struct reply *libramaccept_close(ram_bh bh, int flags, long id, conn_payloadp d)

DESCRIPTION

libramaccept_close implements the libram_close function for the libram-accept module.

It returns action_accept or NULL if flags contain LIBRAM_DISCARD_RESULT.

ARGUMENTS

• bh: backend handle returned by libramaccept_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 structure with action_pass

SEE ALSO

libramaccept_init(3), libramaccept_exit(3), libramaccept_open(3), libramaccept_data(3), ram_bh(3), conn_payload(3), libram_flags(3)

---

libram-accept/libramaccept_data [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_data - libram_data function for libram-accept

SYNOPSIS

struct reply *libramaccept_data(ram_bh bh, int flags, long id, conn_payload* d)

DESCRIPTION

libramaccept_data implements the libram_data function for the libram-accept module.

It returns action_accept or NULL if flags contain LIBRAM_DISCARD_RESULT.

ARGUMENTS

• bh: backend handle returned by libramaccept_init(3)
• flags: flags passed from libram_data(), see libram_flags(3)
• id: connection id
• d: connection data

RETURN

• NULL: flags contain LIBRAM_DISCARD_RESULT or malloc failure
• != NULL: result structure with action_pass

SEE ALSO

libramaccept_init(3), libramaccept_exit(3), ram_bh(3), conn_payload(3), libram_flags(3)

---

libram-accept/libramaccept_exit [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_exit - libram_exit function for libram-accept

SYNOPSIS

int libramaccept_exit(ram_bh bh)

DESCRIPTION

libramaccept_exit implements the libram_exit function for the libram-accept module. It closes the onc/rpc connection opend with libramaccept_init(3)

ARGUMENTS

• bh: backend handle returned by libramaccept_init(3)

RETURN

0

SEE ALSO

libram-accept(3), libram(3), libram_exit(3), ramaccept_bh(3)

---

libram-accept/libramaccept_fd [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_fd - get filedescriptor used by libramaccept

SYNOPSIS

int libramaccept_fd(ram_bh bh)

DESCRIPTION

libramaccept_fd is used to get the file descriptor used internally in libram-accept. No filedescriptor is used and libramaccept_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-accept(3), libramaccept_process(3), libramaccept_wait(3), libram(3)

---

libram-accept/libramaccept_free [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_free - free reply strucutre from libram_process and libram_wait

SYNOPSIS

void libramaccept_free(ram_bh bh, struct reply *res)

DESCRIPTION

libramaccept_free frees the memory allocated with libramaccept_process or libramaccept_wait.

ARGUMENTS

• bh: handle to backend module
• res: pointer to reply structure

SEE ALSO

libram-accept(3), libramaccept_process(3), libramaccept_fd(3), libramaccept_wait(3), libram(3)

---

libram-accept/libramaccept_init [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_init - libram_init function for libram-accept

SYNOPSIS

ram_bh libramaccept_init(char *connect, int *flags)

DESCRIPTION

libramaccept_init implements the libram_init function for the libram-accept module. See libram_init(3) for a general description of the connect and flags parameter. See libram-accept(3) for the description of the connect and flag parameters specific for the libram-accept(3) module.

ARGUMENTS

• connect: connect string
• flags: flags to backend module

RETURN

• NULL: error
• backend_handle of type libramaccept_bh

NOTES

connect is parsed with strtok(3). strtok(3) alters the string and adds null characters to the string.

SEE ALSO

libram-accept(3), libram(3), libram_init(3), strtok(3), ramaccept_bh(3)

---

libram-accept/libramaccept_open [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_open - libram_open function for libram-accept

SYNOPSIS

struct reply *libramaccept_open(ram_bh bh, int flags, 
                long id, conn_hdr* hdr, conn_payload* d)

DESCRIPTION

libramaccept_open implements the libram_open function for the libram-accept module.

It returns action_accept or NULL if flags contain LIBRAM_DISCARD_RESULT.

ARGUMENTS

• bh: backend handle returned by libramaccept_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 action_pass

SEE ALSO

libramaccept_init(3), libramaccept_exit(3), ram_bh(3), conn_hdr(3), conn_payload(3), libram_flags(3)

---

libram-accept/libramaccept_process [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_process - process input on libramaccept file descriptor

SYNOPSIS

struct reply *libramaccept_process(ram_bh bh, fd_set *fds)

DESCRIPTION

libramaccept_process handles input on the libramaccept file descriptor.

Since libram-accept 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-accept(3), libramaccept_fd(3), libramaccept_wait(3), libram(3)

---

libram-accept/libramaccept_result [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_result - result postprecessing for libramaccept callbacks

SYNOPSIS

struct reply * libramaccept_result(ram_bh bh, int flags, long id)

DESCRIPTION

libramaccept_result does postprocessing for libramaccept callbacks. The postprocessing includes:

• all libramaccept callbacks return the 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 libramaccept_init(3)
• flags: flags passed to libramaccept_result(), see libram_flags(3)
• id: connection id

RETURN

• NULL: flags contain LIBRAM_DISCARD_RESULT or malloc failure
• != NULL: result structure with action_pass

SEE ALSO

libramaccept_init(3), libramaccept_exit(3), ram_bh(3), libramaccept_open(3), libramaccept_data(3), libramaccept_close(3), libramaccept_wait(3), libramaccept_process(3), libramaccept_free(3), libram_flags(3)

---

libram-accept/libramaccept_wait [ Functions ]

[ Top ] [ libram-accept ] [ Functions ]

NAME

libramaccept_wait - wait for answer from libramaccept call

SYNOPSIS

struct reply *libramaccept_wait(ram_bh bh, int timeout)

DESCRIPTION

libramaccept_wait waits for an answer from a libramaccept remote procedure call.

Since libram-accept 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 libramaccept_wait(3)

SEE ALSO

libram-accept(3), libramaccept_process(3), libramaccept_fd(3), libram(3)

Generated from ./accept/libram-accept.c with ROBODoc V4.99.36 on Tue Sep 17 2013 15:51:51