qbipcs.h(3) | libqb | qbipcs.h(3) |
qbipcs.h - Server IPC API.
#include <sys/types.h>
#include <sys/uio.h>
#include <qb/qbipc_common.h>
#include <qb/qbloop.h>
struct qb_ipcs_stats
struct qb_ipcs_connection_stats
struct qb_ipcs_connection_stats_2
struct qb_ipcs_poll_handlers
struct qb_ipcs_service_handlers
typedef struct qb_ipcs_connection qb_ipcs_connection_t
typedef struct qb_ipcs_service qb_ipcs_service_t
typedef int32_t(* qb_ipcs_dispatch_fn_t) (int32_t fd, int32_t revents,
void *data)
typedef int32_t(* qb_ipcs_dispatch_add_fn) (enum
qb_loop_priority p, int32_t fd, int32_t events, void *data,
qb_ipcs_dispatch_fn_t fn)
typedef int32_t(* qb_ipcs_dispatch_mod_fn) (enum
qb_loop_priority p, int32_t fd, int32_t events, void *data,
qb_ipcs_dispatch_fn_t fn)
typedef int32_t(* qb_ipcs_dispatch_del_fn) (int32_t fd)
typedef int32_t(* qb_ipcs_job_add_fn) (enum qb_loop_priority p,
void *data, qb_loop_job_dispatch_fn dispatch_fn)
typedef int32_t(* qb_ipcs_connection_accept_fn)
(qb_ipcs_connection_t *c, uid_t uid, gid_t gid)
This callback is to check whether you want to accept a new connection. typedef
void(* qb_ipcs_connection_created_fn) (qb_ipcs_connection_t
*c)
This is called after a new connection has been created. typedef int32_t(*
qb_ipcs_connection_closed_fn) (qb_ipcs_connection_t *c)
This is called after a connection has been disconnected. typedef void(*
qb_ipcs_connection_destroyed_fn) (qb_ipcs_connection_t *c)
This is called just before a connection is freed. typedef int32_t(*
qb_ipcs_msg_process_fn) (qb_ipcs_connection_t *c, void *data,
size_t size)
This is the message processing calback.
enum qb_ipcs_rate_limit { QB_IPCS_RATE_FAST,
QB_IPCS_RATE_NORMAL, QB_IPCS_RATE_SLOW,
QB_IPCS_RATE_OFF, QB_IPCS_RATE_OFF_2 }
qb_ipcs_service_t * qb_ipcs_create (const char
*name, int32_t service_id, enum qb_ipc_type type, struct
qb_ipcs_service_handlers *handlers)
Create a new IPC server. void qb_ipcs_ref (qb_ipcs_service_t *s)
Increase the reference counter on the service object. void
qb_ipcs_unref (qb_ipcs_service_t *s)
Decrease the reference counter on the service object. void
qb_ipcs_poll_handlers_set (qb_ipcs_service_t *s, struct
qb_ipcs_poll_handlers *handlers)
Set your poll callbacks. void qb_ipcs_service_context_set
(qb_ipcs_service_t *s, void *context)
Associate a 'user' pointer with this service. void *
qb_ipcs_service_context_get (qb_ipcs_service_t *s)
Get the context (set previously) int32_t qb_ipcs_run
(qb_ipcs_service_t *s)
run the new IPC server. void qb_ipcs_destroy (qb_ipcs_service_t
*s)
Destroy the IPC server. void qb_ipcs_request_rate_limit
(qb_ipcs_service_t *s, enum qb_ipcs_rate_limit rl)
Limit the incoming request rate. ssize_t qb_ipcs_response_send
(qb_ipcs_connection_t *c, const void *data, size_t size)
Send a response to a incoming request. ssize_t qb_ipcs_response_sendv
(qb_ipcs_connection_t *c, const struct iovec *iov, size_t iov_len)
Send a response to a incoming request. ssize_t qb_ipcs_event_send
(qb_ipcs_connection_t *c, const void *data, size_t size)
Send an asynchronous event message to the client. ssize_t
qb_ipcs_event_sendv (qb_ipcs_connection_t *c, const struct
iovec *iov, size_t iov_len)
Send an asynchronous event message to the client. void
qb_ipcs_connection_ref (qb_ipcs_connection_t *c)
Increment the connection's reference counter. void
qb_ipcs_connection_unref (qb_ipcs_connection_t *c)
Decrement the connection's reference counter. void qb_ipcs_disconnect
(qb_ipcs_connection_t *c)
Disconnect from this client. int32_t qb_ipcs_service_id_get
(qb_ipcs_connection_t *c)
Get the service id related to this connection's service. void
qb_ipcs_context_set (qb_ipcs_connection_t *c, void *context)
Associate a 'user' pointer with this connection. void *
qb_ipcs_context_get (qb_ipcs_connection_t *c)
Get the context (set previously) void *
qb_ipcs_connection_service_context_get (qb_ipcs_connection_t
*c)
Get the context previously set on the service backing this connection. int32_t
qb_ipcs_connection_stats_get (qb_ipcs_connection_t *c, struct
qb_ipcs_connection_stats *stats, int32_t clear_after_read)
Get the connection statistics. struct qb_ipcs_connection_stats_2 *
qb_ipcs_connection_stats_get_2 (qb_ipcs_connection_t *c,
int32_t clear_after_read)
Get (and allocate) the connection statistics. int32_t qb_ipcs_stats_get
(qb_ipcs_service_t *pt, struct qb_ipcs_stats *stats, int32_t
clear_after_read)
Get the service statistics. qb_ipcs_connection_t *
qb_ipcs_connection_first_get (qb_ipcs_service_t *pt)
Get the first connection. qb_ipcs_connection_t *
qb_ipcs_connection_next_get (qb_ipcs_service_t *pt,
qb_ipcs_connection_t *current)
Get the next connection. void qb_ipcs_connection_auth_set
(qb_ipcs_connection_t *conn, uid_t uid, gid_t gid, mode_t mode)
Set the permissions on and shared memory files so that both processes can read
and write to them. int32_t qb_ipcs_connection_get_buffer_size
(qb_ipcs_connection_t *conn)
Retrieve the connection ipc buffer size. void
qb_ipcs_enforce_buffer_size (qb_ipcs_service_t *s, uint32_t
max_buf_size)
Enforce the max buffer size clients must use from the server side.
Server IPC API.
This callback is to check whether you want to accept a new connection. The type of checks you should do are authentication, service availability or process resource constraints.
Returns:
Note:
you can call qb_ipcs_connection_auth_set() within this function.
This is called after a connection has been disconnected.
Note:
if you return anything but 0 this function will be repeatedly called (until 0 is returned).
This is called after a new connection has been created.
Note:
This is called just before a connection is freed.
This is the message processing calback. It is called with the message data.
Enumerator
Set the permissions on and shared memory files so that both processes can read and write to them.
Parameters:
See also:
Note:
Get the first connection.
Note:
Parameters:
Returns:
Retrieve the connection ipc buffer size. This reflects the largest size msg that can be sent or received.
Parameters:
Returns:
Get the next connection.
Note:
Parameters:
Returns:
Increment the connection's reference counter.
Parameters:
Get the context previously set on the service backing this connection.
Parameters:
Returns:
See also:
Get the connection statistics.
Deprecated
Parameters:
Returns:
Get (and allocate) the connection statistics.
Parameters:
Return values:
Decrement the connection's reference counter.
Parameters:
Get the context (set previously)
Parameters:
Returns:
See also:
Associate a 'user' pointer with this connection.
Parameters:
See also:
Create a new IPC server.
Parameters:
Returns:
Destroy the IPC server.
Parameters:
Disconnect from this client.
Parameters:
Enforce the max buffer size clients must use from the server side.
Note:
Parameters:
Send an asynchronous event message to the client.
Parameters:
Returns:
Note:
When send returns -EMSGSIZE, this means the msg is too large and will never succeed. To determine the max msg size a client can be sent, use qb_ipcs_connection_get_buffer_size()
Send an asynchronous event message to the client.
Parameters:
Returns:
Note:
When send returns -EMSGSIZE, this means the msg is too large and will never succeed. To determine the max msg size a client can be sent, use qb_ipcs_connection_get_buffer_size()
Set your poll callbacks.
Parameters:
Increase the reference counter on the service object.
Parameters:
Limit the incoming request rate.
Parameters:
Send a response to a incoming request.
Parameters:
Returns:
Note:
Send a response to a incoming request.
Parameters:
Returns:
Note:
When send returns -EMSGSIZE, this means the msg is too large and will never succeed. To determine the max msg size a client can be sent, use qb_ipcs_connection_get_buffer_size()
run the new IPC server.
Parameters:
Returns:
Get the context (set previously)
Parameters:
Returns:
See also:
Associate a 'user' pointer with this service.
Parameters:
See also:
Get the service id related to this connection's service. (as passed into qb_ipcs_create()
Returns:
Get the service statistics.
Parameters:
Returns:
Decrease the reference counter on the service object.
Parameters:
Generated automatically by Doxygen for libqb from the source code.
Fri Apr 26 2019 | Version 1.0.5 |