include/tr_msg.h

   1 /*
   2  * Copyright (c) 2012-2014, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  31  * OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef TR_MSG_H
  36 #define TR_MSG_H
  37
  38 #include <jansson.h>
  39 #include <trust_router/tid.h>
  40 #include <trust_router/trp.h>
  41 #include <mon_internal.h>
  42
  43 typedef struct tr_msg TR_MSG;
  44
  45 enum msg_type {
  46   TR_UNKNOWN = 0,
  47   TID_REQUEST,
  48   TID_RESPONSE,
  49   TRP_UPDATE,
  50   TRP_REQUEST,
  51   MON_REQUEST,
  52   MON_RESPONSE
  53 };
  54
  55 /* Union of TR message types to hold message of any type. */
  56 struct tr_msg {
  57   enum msg_type msg_type;
  58   void *msg_rep;
  59 };
  60
  61 /* Accessors */
  62 enum msg_type tr_msg_get_msg_type(TR_MSG *msg);
  63 void tr_msg_set_msg_type(TR_MSG *msg, enum msg_type type);
  64 TID_REQ *tr_msg_get_req(TR_MSG *msg);
  65 void tr_msg_set_req(TR_MSG *msg, TID_REQ *req);
  66 TID_RESP *tr_msg_get_resp(TR_MSG *msg);
  67 void tr_msg_set_resp(TR_MSG *msg, TID_RESP *resp);
  68 TRP_UPD *tr_msg_get_trp_upd(TR_MSG *msg);
  69 void tr_msg_set_trp_upd(TR_MSG *msg, TRP_UPD *req);
  70 TRP_REQ *tr_msg_get_trp_req(TR_MSG *msg);
  71 void tr_msg_set_trp_req(TR_MSG *msg, TRP_REQ *req);
  72 MON_REQ *tr_msg_get_mon_req(TR_MSG *msg);
  73 void tr_msg_set_mon_req(TR_MSG *msg, MON_REQ *req);
  74 MON_RESP *tr_msg_get_mon_resp(TR_MSG *msg);
  75 void tr_msg_set_mon_resp(TR_MSG *msg, MON_RESP *resp);
  76
  77
  78 /* Encoders/Decoders */
  79 char *tr_msg_encode(TALLOC_CTX *mem_ctx, TR_MSG *msg);
  80 TR_MSG *tr_msg_decode(TALLOC_CTX *mem_ctx, const char *jmsg, size_t len);
  81 void tr_msg_free_encoded(char *jmsg);
  82 void tr_msg_free_decoded(TR_MSG *msg);
  83
  84
  85 #endif