libram API

Table of Contents Sourcefiles index Generics Functions Structures Variables

TABLE OF CONTENTS

• 1. libram-deny/libram-deny
• 1.1. libram-deny/libramdeny
• 1.2. libram-deny/libramdeny_close
• 1.3. libram-deny/libramdeny_data
• 1.4. libram-deny/libramdeny_exit
• 1.5. libram-deny/libramdeny_fd
• 1.6. libram-deny/libramdeny_free
• 1.7. libram-deny/libramdeny_init
• 1.8. libram-deny/libramdeny_open
• 1.9. libram-deny/libramdeny_process
• 1.10. libram-deny/libramdeny_result
• 1.11. libram-deny/libramdeny_wait
• 1.12. libram-deny/ramdeny_bh

---

libram-deny/libram-deny [ Generics ]

[ Top ] [ Generics ]

NAME

libram-deny - deny backend to libram

DESCRIPTION

libram-deny is a backend module for libram, that denies all incoming requests.

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

SEE ALSO

libram(3), libramdeny(3), libram_init(3)

---

libram-deny/libramdeny [ Variables ]

[ Top ] [ libram-deny ] [ Variables ]

NAME

libramdeny - libram_module structure for libram-deny module

DESCRIPTION

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

SOURCE

struct libram_module libramdeny = {
        "deny",
        NULL,

        libramdeny_init,
        libramdeny_exit,

        libramdeny_open,
        libramdeny_data,
        libramdeny_close,

        libramdeny_fd,
        libramdeny_process,
        libramdeny_wait,
        libramdeny_free,
};

SEE ALSO

libram(3), libram_module(3), libram-deny(3)

---

libram-deny/libramdeny_close [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_close - libram_close function for libram-deny

SYNOPSIS

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

DESCRIPTION

libramdeny_close implements the libram_close function for the libram-deny module.

It returns action_deny or NULL if flags contain LIBRAM_DISCARD_RESULT.

ARGUMENTS

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

libramdeny_init(3), libramdeny_exit(3), libramdeny_open(3), libramdeny_data(3), ram_bh(3), conn_payload(3), libram_flags(3)

---

libram-deny/libramdeny_data [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_data - libram_data function for libram-deny

SYNOPSIS

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

DESCRIPTION

libramdeny_data implements the libram_data function for the libram-deny module.

It returns action_deny or NULL if flags contain LIBRAM_DISCARD_RESULT.

ARGUMENTS

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

libramdeny_init(3), libramdeny_exit(3), ram_bh(3), conn_payload(3), libram_flags(3)

---

libram-deny/libramdeny_exit [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_exit - libram_exit function for libram-deny

SYNOPSIS

int libramdeny_exit(ram_bh bh)

DESCRIPTION

libramdeny_exit implements the libram_exit function for the libram-deny module. It closes the onc/rpc connection opend with libramdeny_init(3)

ARGUMENTS

• bh: backend handle returned by libramdeny_init(3)

RETURN

0

SEE ALSO

libram-deny(3), libram(3), libram_exit(3), ramdeny_bh(3)

---

libram-deny/libramdeny_fd [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_fd - get filedescriptor used by libramdeny

SYNOPSIS

int libramdeny_fd(ram_bh bh)

DESCRIPTION

libramdeny_fd is used to get the file descriptor used internally in libram-deny. No filedescriptor is used and libramdeny_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-deny(3), libramdeny_process(3), libramdeny_wait(3), libram(3)

---

libram-deny/libramdeny_free [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_free - free reply strucutre from libram_process and libram_wait

SYNOPSIS

void libramdeny_free(ram_bh bh, struct reply *res)

DESCRIPTION

libramdeny_free frees the memory allocated with libramdeny_process or libramdeny_wait.

ARGUMENTS

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

SEE ALSO

libram-deny(3), libramdeny_process(3), libramdeny_fd(3), libramdeny_wait(3), libram(3)

---

libram-deny/libramdeny_init [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_init - libram_init function for libram-deny

SYNOPSIS

ram_bh libramdeny_init(char *connect, int *flags)

DESCRIPTION

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

ARGUMENTS

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

RETURN

• NULL: error
• backend_handle of type libramdeny_bh

NOTES

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

SEE ALSO

libram-deny(3), libram(3), libram_init(3), strtok(3), ramdeny_bh(3)

---

libram-deny/libramdeny_open [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_open - libram_open function for libram-deny

SYNOPSIS

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

DESCRIPTION

libramdeny_open implements the libram_open function for the libram-deny module.

It returns action_deny or NULL if flags contain LIBRAM_DISCARD_RESULT.

ARGUMENTS

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

libramdeny_init(3), libramdeny_exit(3), ram_bh(3), conn_hdr(3), conn_payload(3), libram_flags(3)

---

libram-deny/libramdeny_process [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_process - process input on libramdeny file descriptor

SYNOPSIS

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

DESCRIPTION

libramdeny_process handles input on the libramdeny file descriptor.

Since libram-deny 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-deny(3), libramdeny_fd(3), libramdeny_wait(3), libram(3)

---

libram-deny/libramdeny_result [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_result - result postprecessing for libramdeny callbacks

SYNOPSIS

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

DESCRIPTION

libramdeny_result does postprocessing for libramdeny callbacks. The postprocessing includes:

• all libramdeny callbacks return the action_deny 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 libramdeny_init(3)
• flags: flags passed to libramdeny_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

libramdeny_init(3), libramdeny_exit(3), ram_bh(3), libramdeny_open(3), libramdeny_data(3), libramdeny_close(3), libramdeny_wait(3), libramdeny_process(3), libramdeny_free(3), libram_flags(3)

---

libram-deny/libramdeny_wait [ Functions ]

[ Top ] [ libram-deny ] [ Functions ]

NAME

libramdeny_wait - wait for answer from libramdeny call

SYNOPSIS

struct reply *libramdeny_wait(ram_bh bh, int timeout)

DESCRIPTION

libramdeny_wait waits for an answer from a libramdeny remote procedure call.

Since libram-deny 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 libramdeny_wait(3)

SEE ALSO

libram-deny(3), libramdeny_process(3), libramdeny_fd(3), libram(3)

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