connection.h

Go to the documentation of this file.

/*
 * Copyright 2015-2017 Two Pore Guys, Inc.
 * All rights reserved
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted providing that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef LIBRPC_CONNECTION_H
#define LIBRPC_CONNECTION_H

#include <Block.h>
#include <sys/time.h>
#include <rpc/config.h>
#include <rpc/object.h>
#ifdef ENABLE_LIBDISPATCH
#include <dispatch/dispatch.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

struct rpc_context;
struct rpc_connection;
struct rpc_call;

typedef enum rpc_error_code
{
    RPC_INVALID_RESPONSE = 1,   
    RPC_CONNECTION_TIMEOUT,     
    RPC_CONNECTION_CLOSED,      
    RPC_CALL_TIMEOUT,       
    RPC_SPURIOUS_RESPONSE,      
    RPC_LOGOUT,         
    RPC_TRANSPORT_ERROR,        
    RPC_OTHER           
} rpc_error_code_t;

typedef enum rpc_call_status
{
    RPC_CALL_IN_PROGRESS,       
    RPC_CALL_STREAM_START,      
    RPC_CALL_MORE_AVAILABLE,    
    RPC_CALL_DONE,          
    RPC_CALL_ERROR,         
    RPC_CALL_ABORTED,       
    RPC_CALL_ENDED          
} rpc_call_status_t;

typedef enum rpc_call_type
{
    RPC_OUTBOUND_CALL,      
    RPC_INBOUND_CALL,       
} rpc_call_type_t;

typedef struct rpc_connection *rpc_connection_t;

typedef struct rpc_call *rpc_call_t;

typedef void (^rpc_handler_t)(const char *_Nullable path,
    const char *_Nullable interface, const char *_Nonnull name,
    _Nonnull rpc_object_t args);

typedef void (^rpc_property_handler_t)(_Nonnull rpc_object_t value);

typedef void (^rpc_error_handler_t)(rpc_error_code_t code,
    _Nullable rpc_object_t args);

typedef int (^rpc_raw_handler_t)(const void *_Nonnull msg, size_t len,
    const int *_Nullable fds, size_t nfds);

typedef bool (^rpc_callback_t)(_Nonnull rpc_call_t call);

#define RPC_HANDLER(_fn, _arg)                      \
    ^(const char *_path, const char *_iface, const char *_name,     \
        rpc_object_t _args) {                   \
        _fn(_arg, _path, _iface, _name, _args);         \
    }

#define RPC_PROPERTY_HANDLER(_fn, _arg)                 \
    ^(rpc_object_t _value) {                    \
        _fn(_arg, _value);                  \
    }

#define RPC_ERROR_HANDLER(_fn, _arg)                    \
    ^(rpc_error_code_t _code, rpc_object_t _args) {         \
        _fn(_arg, _code, _args);                \
    }

#define RPC_RAW_HANDLER(_fn, _arg)                  \
    ^(const void *_msg, size_t _len, const int *_fds, size_t _nfd) {\
        return (_fn(_arg, _msg, _len, _fds, _nfd));     \
    }

#define RPC_CALLBACK(_fn, _arg)                     \
    ^(rpc_object_t _args, rpc_call_status_t _status) {      \
        return ((bool)_fn(_arg, _args, _status));       \
    }

#define RPC_NULL_FORMAT "[]"

_Nullable rpc_connection_t rpc_connection_create(void *_Nonnull cookie,
    _Nullable rpc_object_t params);

int rpc_connection_close(_Nonnull rpc_connection_t conn);

struct rpc_context *_Nullable rpc_connection_get_context(
    _Nonnull rpc_connection_t conn);

int rpc_connection_set_context(_Nonnull rpc_connection_t conn,
    struct rpc_context *_Nonnull ctx);

bool rpc_connection_is_open(_Nonnull rpc_connection_t conn);

bool rpc_connection_is_valid(_Nonnull rpc_connection_t conn);

int rpc_connection_get_fd(_Nonnull rpc_connection_t conn);

void rpc_connection_free(_Nonnull rpc_connection_t conn);

#ifdef ENABLE_LIBDISPATCH

int rpc_connection_set_dispatch_queue(_Nonnull rpc_connection_t conn,
    _Nonnull dispatch_queue_t queue);
#endif

int rpc_connection_subscribe_event(_Nonnull rpc_connection_t conn,
    const char *_Nullable path, const char *_Nullable interface,
    const char *_Nonnull name);

int rpc_connection_unsubscribe_event(_Nonnull rpc_connection_t conn,
    const char *_Nullable path, const char *_Nullable interface,
    const char *_Nonnull name);

void *_Nullable rpc_connection_register_event_handler(
    _Nonnull rpc_connection_t conn, const char *_Nullable path,
    const char *_Nullable interface, const char *_Nonnull name,
    _Nullable rpc_handler_t handler);

int rpc_connection_unregister_event_handler(_Nonnull rpc_connection_t conn,
    void *_Nonnull cookie);

_Nullable rpc_object_t rpc_connection_call_sync(_Nonnull rpc_connection_t conn,
    const char *_Nullable path, const char *_Nullable interface,
    const char *_Nonnull method, ...);

_Nullable rpc_object_t rpc_connection_call_syncv(_Nonnull rpc_connection_t conn,
    const char *_Nullable path, const char *_Nullable interface,
    const char *_Nonnull method, va_list ap);

_Nullable rpc_object_t rpc_connection_call_syncp(_Nonnull rpc_connection_t conn,
    const char *_Nullable path, const char *_Nullable interface,
    const char *_Nonnull method, const char *_Nonnull fmt, ...);

_Nullable rpc_object_t rpc_connection_call_syncpv(
    _Nonnull rpc_connection_t conn, const char *_Nullable path,
    const char *_Nullable interface, const char *_Nonnull method,
    const char *_Nonnull fmt, va_list ap);

_Nullable rpc_object_t rpc_connection_call_simple(
    _Nonnull rpc_connection_t conn, const char *_Nonnull name,
    const char *_Nonnull fmt, ...);

_Nullable rpc_call_t rpc_connection_call(_Nonnull rpc_connection_t conn,
    const char *_Nullable path, const char *_Nullable interface,
    const char *_Nonnull name, _Nullable rpc_object_t args,
    _Nullable rpc_callback_t callback);

_Nullable rpc_object_t rpc_connection_get_property(
    _Nonnull rpc_connection_t conn, const char *_Nullable path,
    const char *_Nullable interface, const char *_Nonnull name);

_Nullable rpc_object_t rpc_connection_set_property(
    _Nonnull rpc_connection_t conn, const char *_Nullable path,
    const char *_Nullable interface, const char *_Nonnull name,
    rpc_object_t _Nonnull value);


_Nullable rpc_object_t rpc_connection_set_propertyp(
    _Nonnull rpc_connection_t conn, const char *_Nullable path,
    const char *_Nullable interface, const char *_Nonnull name,
    const char *_Nonnull fmt, ...);

_Nullable rpc_object_t rpc_connection_set_propertypv(
    _Nonnull rpc_connection_t conn, const char *_Nullable path,
    const char *_Nullable interface, const char *_Nonnull name,
    const char *_Nonnull fmt, va_list ap);

void *_Nullable rpc_connection_watch_property(
    _Nonnull rpc_connection_t conn, const char *_Nullable path,
    const char *_Nullable interface, const char *_Nonnull property,
    _Nonnull rpc_property_handler_t handler);

int rpc_connection_send_event(_Nonnull rpc_connection_t conn,
    const char *_Nullable path, const char *_Nullable interface,
    const char *_Nonnull name, _Nonnull rpc_object_t args);

int rpc_connection_ping(_Nonnull rpc_connection_t conn);

int rpc_connection_send_raw_message(_Nonnull rpc_connection_t conn,
    const void *_Nonnull msg, size_t len, const int *_Nullable fds,
    size_t nfds);

void rpc_connection_set_raw_message_handler(_Nonnull rpc_connection_t conn,
    _Nullable rpc_raw_handler_t handler);

void rpc_connection_set_event_handler(_Nonnull rpc_connection_t conn,
    _Nullable rpc_handler_t handler);

void rpc_connection_set_error_handler(_Nonnull rpc_connection_t conn,
    _Nullable rpc_error_handler_t handler);

const char *_Nullable rpc_connection_get_remote_address(
    _Nonnull rpc_connection_t conn);

bool rpc_connection_supports_fd_passing(_Nonnull rpc_connection_t conn);

bool rpc_connection_supports_credentials(_Nonnull rpc_connection_t conn);

bool rpc_connection_has_credentials(_Nonnull rpc_connection_t conn);

uid_t rpc_connection_get_remote_uid(_Nonnull rpc_connection_t conn);

gid_t rpc_connection_get_remote_gid(_Nonnull rpc_connection_t conn);

pid_t rpc_connection_get_remote_pid(_Nonnull rpc_connection_t conn);

int rpc_call_wait(_Nonnull rpc_call_t call);

int rpc_call_continue(_Nonnull rpc_call_t call, bool sync);

int rpc_call_abort(_Nonnull rpc_call_t call);

int rpc_call_set_prefetch(_Nonnull rpc_call_t call, size_t nitems);

int rpc_call_timedwait(_Nonnull rpc_call_t call,
    const struct timespec *_Nonnull ts);

int rpc_call_success(_Nonnull rpc_call_t call);

rpc_call_status_t rpc_call_status(_Nonnull rpc_call_t call);

_Nullable rpc_object_t rpc_call_result(_Nonnull rpc_call_t call);

void rpc_call_free(_Nonnull rpc_call_t call);

#ifdef __cplusplus
}
#endif

#endif /* LIBRPC_CONNECTION_H */