src/afb-wsj1.h

   1 /*
   2  * Copyright (C) 2016 "IoT.bzh"
   3  * Author: José Bollo <jose.bollo@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 struct afb_wsj1;
  21 struct afb_wsj1_msg;
  22
  23 struct json_object;
  24
  25 /*
  26  * Interface for callback functions.
  27  * The received closure is the closure passed when creating the afb_wsj1
  28  * socket using afb_wsj1_create.
  29  */
  30 struct afb_wsj1_itf {
  31         /*
  32          *  This function is called on hangup.
  33          *  Receives the 'closure' and the handle 'wsj1'
  34          */
  35         void (*on_hangup)(void *closure, struct afb_wsj1 *wsj1);
  36
  37         /*
  38          * This function is called on incoming call.
  39          * Receives the 'closure'
  40          */
  41         void (*on_call)(void *closure, const char *api, const char *verb, struct afb_wsj1_msg *msg);
  42
  43         /*
  44          * This function is called on incoming event
  45          */
  46         void (*on_event)(void *closure, const char *event, struct afb_wsj1_msg *msg);
  47 };
  48
  49 /*
  50  * Creates the afb_wsj1 socket connected to the file descriptor 'fd'
  51  * and having the callback interface defined by 'itf' for the 'closure'.
  52  * Returns the created wsj1 websocket or NULL in case of error.
  53  */
  54 extern struct afb_wsj1 *afb_wsj1_create(int fd, struct afb_wsj1_itf *itf, void *closure);
  55
  56 /*
  57  * Increases by one the count of reference to 'wsj1'
  58  */
  59 extern void afb_wsj1_addref(struct afb_wsj1 *wsj1);
  60
  61 /*
  62  * Decreases by one the count of reference to 'wsj1'
  63  * and if it falls to zero releases the used resources
  64  * and free the memory
  65  */
  66 extern void afb_wsj1_unref(struct afb_wsj1 *wsj1);
  67
  68 /*
  69  * Sends on 'wsj1' the event of name 'event' with the
  70  * data 'object'. If not NULL, 'object' should be a valid
  71  * JSON string.
  72  * Return 0 in case of success. Otherwise, returns -1 and set errno.
  73  */
  74 extern int afb_wsj1_send_event_s(struct afb_wsj1 *wsj1, const char *event, const char *object);
  75
  76 /*
  77  * Sends on 'wsj1' the event of name 'event' with the
  78  * data 'object'. 'object' can be NULL.
  79  * Return 0 in case of success. Otherwise, returns -1 and set errno.
  80  */
  81 extern int afb_wsj1_send_event_j(struct afb_wsj1 *wsj1, const char *event, struct json_object *object);
  82
  83 /*
  84  * Sends on 'wsj1' a call to the method of 'api'/'verb' with arguments
  85  * given by 'object'. If not NULL, 'object' should be a valid JSON string.
  86  * On receiving the reply, the function 'on_reply' is called with 'closure'
  87  * as its first argument and the message of the reply.
  88  * Return 0 in case of success. Otherwise, returns -1 and set errno.
  89  */
  90 extern int afb_wsj1_call_s(struct afb_wsj1 *wsj1, const char *api, const char *verb, const char *object, void (*on_reply)(void *closure, struct afb_wsj1_msg *msg), void *closure);
  91
  92 /*
  93  * Sends on 'wsj1' a call to the method of 'api'/'verb' with arguments
  94  * given by 'object'. 'object' can be NULL.
  95  * On receiving the reply, the function 'on_reply' is called with 'closure'
  96  * as its first argument and the message of the reply.
  97  * Return 0 in case of success. Otherwise, returns -1 and set errno.
  98  */
  99 extern int afb_wsj1_call_j(struct afb_wsj1 *wsj1, const char *api, const char *verb, struct json_object *object, void (*on_reply)(void *closure, struct afb_wsj1_msg *msg), void *closure);
 100
 101 /*
 102  * Sends for message 'msg' the OK reply with the 'object' and, if not NULL, the token.
 103  * If not NULL, 'object' should be a valid JSON string.
 104  * Return 0 in case of success. Otherwise, returns -1 and set errno.
 105  */
 106 extern int afb_wsj1_reply_ok_s(struct afb_wsj1_msg *msg, const char *object, const char *token);
 107
 108 /*
 109  * Sends for message 'msg' the OK reply with the 'object' and, if not NULL, the token.
 110  * 'object' can be NULL.
 111  * Return 0 in case of success. Otherwise, returns -1 and set errno.
 112  */
 113 extern int afb_wsj1_reply_ok_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token);
 114
 115 /*
 116  * Sends for message 'msg' the ERROR reply with the 'object' and, if not NULL, the token.
 117  * If not NULL, 'object' should be a valid JSON string.
 118  * Return 0 in case of success. Otherwise, returns -1 and set errno.
 119  */
 120 extern int afb_wsj1_reply_error_s(struct afb_wsj1_msg *msg, const char *object, const char *token);
 121
 122 /*
 123  * Sends for message 'msg' the ERROR reply with the 'object' and, if not NULL, the token.
 124  * 'object' can be NULL.
 125  * Return 0 in case of success. Otherwise, returns -1 and set errno.
 126  */
 127 extern int afb_wsj1_reply_error_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token);
 128
 129 /*
 130  * Increases by one the count of reference to 'msg'.
 131  * Should be called if callbacks stores the message.
 132  */
 133 extern void afb_wsj1_msg_addref(struct afb_wsj1_msg *msg);
 134
 135 /*
 136  * Decreases by one the count of reference to 'msg'.
 137  * and if it falls to zero releases the used resources
 138  * and free the memory.
 139  * Should be called if 'afb_wsj1_msg_addref' was called.
 140  */
 141 extern void afb_wsj1_msg_unref(struct afb_wsj1_msg *msg);
 142
 143 /*
 144  * Returns 1 if 'msg' is for a CALL
 145  * Otherwise returns 0.
 146  */
 147 extern int afb_wsj1_msg_is_call(struct afb_wsj1_msg *msg);
 148
 149 /*
 150  * Returns 1 if 'msg' is for a REPLY of any kind
 151  * Otherwise returns 0.
 152  */
 153 extern int afb_wsj1_msg_is_reply(struct afb_wsj1_msg *msg);
 154
 155 /*
 156  * Returns 1 if 'msg' is for a REPLY OK
 157  * Otherwise returns 0.
 158  */
 159 extern int afb_wsj1_msg_is_reply_ok(struct afb_wsj1_msg *msg);
 160
 161 /*
 162  * Returns 1 if 'msg' is for a REPLY ERROR
 163  * Otherwise returns 0.
 164  */
 165 extern int afb_wsj1_msg_is_reply_error(struct afb_wsj1_msg *msg);
 166
 167 /*
 168  * Returns 1 if 'msg' is for an EVENT
 169  * Otherwise returns 0.
 170  */
 171 extern int afb_wsj1_msg_is_event(struct afb_wsj1_msg *msg);
 172
 173 /*
 174  * Returns the api of the call for 'msg'
 175  * Returns NULL if 'msg' is not for a CALL
 176  */
 177 extern const char *afb_wsj1_msg_api(struct afb_wsj1_msg *msg);
 178
 179 /*
 180  * Returns the verb call for 'msg'
 181  * Returns NULL if 'msg' is not for a CALL
 182  */
 183 extern const char *afb_wsj1_msg_verb(struct afb_wsj1_msg *msg);
 184
 185 /*
 186  * Returns the event name for 'msg'
 187  * Returns NULL if 'msg' is not for an EVENT
 188  */
 189 extern const char *afb_wsj1_msg_event(struct afb_wsj1_msg *msg);
 190
 191 /*
 192  * Returns the token sent with 'msg' or NULL when no token was sent.
 193  */
 194 extern const char *afb_wsj1_msg_token(struct afb_wsj1_msg *msg);
 195
 196 /*
 197  * Returns the wsj1 of 'msg'
 198  */
 199 extern struct afb_wsj1 *afb_wsj1_msg_wsj1(struct afb_wsj1_msg *msg);
 200
 201 /*
 202  * Returns the string representation of the object received with 'msg'
 203  */
 204 extern const char *afb_wsj1_msg_object_s(struct afb_wsj1_msg *msg);
 205
 206 /*
 207  * Returns the object received with 'msg'
 208  */
 209 extern struct json_object *afb_wsj1_msg_object_j(struct afb_wsj1_msg *msg);
 210