msg.h File Reference

#include "gwlib/gwlib.h"
#include "msg-decl.h"

Go to the source code of this file.

Data Structures
struct	Msg
struct	split_parts

Macros
#define	MSG_PARAM_UNDEFINED   -1
#define	MSG(type, stmt)   type,
#define	INTEGER(name)   long name;
#define	OCTSTR(name)   Octstr *name;
#define	UUID(name)   uuid_t name;
#define	VOID(name)   void *name;
#define	MSG(type, stmt)   struct type stmt type;
#define	msg_create(type)   gw_claim_area(msg_create_real((type), __FILE__, __LINE__, __func__))
#define	msg_unpack(os)   gw_claim_area(msg_unpack_real((os), __FILE__, __LINE__, __func__))

Enumerations
enum	msg_type { MSG, MSG }
enum	{   mo = 0, mt_reply = 1, mt_push = 2, report_mo = 3,   report_mt = 4 }
enum	{   cmd_shutdown = 0, cmd_suspend = 1, cmd_resume = 2, cmd_identify = 3,   cmd_restart = 4, cmd_feature = 5 }
enum	ack_status_t { ack_success = 0, ack_failed = 1, ack_failed_tmp = 2, ack_buffered = 3 }

Functions
Msg *	msg_create_real (enum msg_type type, const char *file, long line, const char *func)
Msg *	msg_duplicate (Msg *msg)
enum msg_type	msg_type (Msg *msg)
void	msg_destroy (Msg *msg)
void	msg_destroy_item (void *msg)
void	msg_dump (Msg *msg, int level)
Octstr *	msg_pack (Msg *msg)
Msg *	msg_unpack_real (Octstr *os, const char *file, long line, const char *func)
Msg *	msg_unpack_wrapper (Octstr *os)

Macro Definition Documentation

INTEGER

#define INTEGER

(

name

)

long name;

Definition at line 82 of file msg.h.

MSG [1/2]

#define MSG	(		type,
			stmt
	)		type,

Definition at line 86 of file msg.h.

MSG [2/2]

#define MSG	(		type,
			stmt
	)		struct type stmt type;

Definition at line 86 of file msg.h.

msg_create

#define msg_create

(

type

)

gw_claim_area(msg_create_real((type), __FILE__, __LINE__, __func__))

Definition at line 136 of file msg.h.

Referenced by at2_pdu_decode_deliver_sm(), bb_remove_message(), bearerbox_to_smpp(), bearerbox_to_sql(), boxc_receiver(), boxc_sender(), brunet_receive_sms(), cgw_handle_op(), cimd2_accept_message(), cimd_receive_msg(), clickatell_receive_sms(), create_dlr_from_msg(), data_sm_to_msg(), deliver_sms_to_queue(), dlr_find(), dlr_spool_add(), generic_receive_sms(), handle_operation(), heartbeat_thread(), identify_to_bearerbox(), kannel_receive_sms(), main(), msg_duplicate(), msg_to_bb(), obey_request_thread(), ois_deliver_sm_invoke(), oisd_accept_message(), ota_pack_message(), ota_tokenize_bookmarks(), ota_tokenize_settings(), pack_ip_datagram(), pack_sms_datagram(), parse_rawmessage_to_msg(), pdu_to_msg(), remember_receiver(), run_batch(), run_connects(), sema_receive_msg(), smsbox_req_handle(), smsbox_thread(), soap_parse_mo(), store_file_save_ack(), store_spool_save_ack(), udp_receiver(), wdp_create(), and xidris_receive_sms().

MSG_PARAM_UNDEFINED

#define MSG_PARAM_UNDEFINED   -1

Definition at line 71 of file msg.h.

Referenced by at2_pdu_encode(), get_pattern(), msg_cb(), packet_encode_message(), store_spool_save(), store_to_dict(), and urltrans_fill_escape_codes().

msg_unpack

#define msg_unpack

(

os

)

gw_claim_area(msg_unpack_real((os), __FILE__, __LINE__, __func__))

Definition at line 183 of file msg.h.

Referenced by main(), msg_unpack_wrapper(), read_from_bearerbox_real(), read_from_box(), run_requests(), and smsbox_thread().

OCTSTR

#define OCTSTR

(

name

)

Octstr *name;

Definition at line 83 of file msg.h.

UUID

#define UUID

(

name

)

uuid_t name;

Definition at line 84 of file msg.h.

VOID

#define VOID

(

name

)

void *name;

Definition at line 85 of file msg.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
mo
mt_reply
mt_push
report_mo
report_mt

Definition at line 105 of file msg.h.

     {
    mo = 0,
    mt_reply = 1,
    mt_push = 2,
    report_mo = 3,
    report_mt = 4
};

anonymous enum

anonymous enum

Enumerator
cmd_shutdown
cmd_suspend
cmd_resume
cmd_identify
cmd_restart
cmd_feature

Definition at line 114 of file msg.h.

     {
    cmd_shutdown = 0,
    cmd_suspend = 1,
    cmd_resume = 2,
    cmd_identify = 3,
    cmd_restart = 4,
    cmd_feature = 5,
};

ack_status_t

enum ack_status_t

Enumerator
ack_success
ack_failed
ack_failed_tmp
ack_buffered

Definition at line 124 of file msg.h.

             {
    ack_success = 0,
    ack_failed = 1,     /* do not try again (e.g. no route) */
    ack_failed_tmp = 2, /* temporary failed, try again (e.g. queue full) */
    ack_buffered = 3
} ack_status_t;

msg_type

enum serverHelloDonePDU u handshake msg_type = server_hello_done

Enumerator
MSG
MSG

Definition at line 73 of file msg.h.

              {
    #define MSG(type, stmt) type,
    #include "msg-decl.h"
    msg_type_count
};

Function Documentation

msg_create_real()

Msg* msg_create_real	(	enum msg_type	type,
		const char *	file,
		long	line,
		const char *	func
	)

Definition at line 93 of file msg.c.

References file, msg, and type.

Referenced by msg_unpack_real().

{
    Msg *msg;

    msg = gw_malloc_trace(sizeof(Msg), file, line, func);

    msg->type = type;
#define INTEGER(name) p->name = MSG_PARAM_UNDEFINED;
#define OCTSTR(name) p->name = NULL;
#define UUID(name) uuid_generate(p->name);
#define VOID(name) p->name = NULL;
#define MSG(type, stmt) { struct type *p = &msg->type; stmt }
#include "msg-decl.h"

    return msg;
}

msg_destroy()

void msg_destroy

(

Msg *

msg

)

Definition at line 132 of file msg.c.

References msg.

Referenced by bb_remove_message(), bb_smscconn_receive(), bb_smscconn_receive_internal(), bb_smscconn_send_failed(), bb_smscconn_sent(), bearerbox_to_smpp(), bearerbox_to_smsbox(), bearerbox_to_sql(), boxc_receiver(), boxc_sender(), boxc_sent_pop(), catenate_msg(), cimd2_accept_message(), concat_handling_check_and_handle(), concat_handling_clear_old_parts(), data_sm_to_msg(), deliver_sms_to_queue(), deliver_to_bearerbox_real(), destroy_concatMsg(), dispatch_datagram(), dispatch_into_queue(), dlr_spool_add(), dlr_spool_get(), emi_receive_msg(), empty_msg_lists(), generic_receive_sms(), handle_pdu(), handle_split(), http_queue_thread(), identify_to_bearerbox(), main(), main_connection_loop(), msg_destroy_item(), msg_to_bb(), msg_to_pdu(), msg_unpack_real(), obey_request_thread(), ois_deliver_sm_invoke(), oisd_accept_message(), pdu_to_msg(), read_messages_from_bearerbox(), retry_consumer_thread(), run_batch(), run_requests(), send_message(), send_pdu(), smpp_msg_destroy(), sms_receive(), sms_router(), sms_split(), smsbox_req_handle(), smsbox_req_sendota(), smsbox_sendota_post(), smsbox_thread(), smsbox_to_bearerbox(), smsc2_rout(), sql_list(), sql_single(), status_cb(), store_file_load(), store_file_save_ack(), store_spool_save_ack(), store_to_dict(), timer_consumer_thread(), udp_sender(), url_result_thread(), wdp_to_wapboxes(), wrapper_sender(), and write_to_bearerbox_real().

{
    if (msg == NULL)
        return;

#define INTEGER(name) p->name = 0;
#define OCTSTR(name) octstr_destroy(p->name);
#define UUID(name) uuid_clear(p->name);
#define VOID(name)
#define MSG(type, stmt) { struct type *p = &msg->type; stmt }
#include "msg-decl.h"

    gw_free(msg);
}

msg_destroy_item()

void msg_destroy_item

(

void *

msg

)

Definition at line 147 of file msg.c.

References msg, and msg_destroy().

Referenced by boxc_create(), cimd2_destroy(), empty_msg_lists(), handle_pdu(), msg_to_pdu(), oisd_destroy(), run_batch(), smasi_destroy(), smpp_destroy(), smscconn_send(), sql_list(), and store_file_init().

{
    msg_destroy(msg);
}

msg_dump()

void msg_dump	(	Msg *	msg,
		int	level
	)

Definition at line 152 of file msg.c.

References debug(), msg, type_as_str(), and UUID_STR_LEN.

Referenced by bearerbox_to_smpp(), boxc_sent_pop(), concat_handling_check_and_handle(), dump(), handle_pdu(), main(), obey_request_thread(), print_msg(), read_messages_from_bearerbox(), send_message(), and store_file_load().

{
    char buf[UUID_STR_LEN + 1];

    debug("gw.msg", 0, "%*sMsg object at %p:", level, "", (void *) msg);
    debug("gw.msg", 0, "%*s type: %s", level, "", type_as_str(msg));
#define INTEGER(name) \
    debug("gw.msg", 0, "%*s %s.%s: %ld", level, "", t, #name, (long) p->name);
#define OCTSTR(name) \
    debug("gw.msg", 0, "%*s %s.%s:", level, "", t, #name); \
    octstr_dump(p->name, level + 1);
#define UUID(name) \
    uuid_unparse(p->name, buf); \
    debug("gw.msg", 0 , "%*s %s.%s: %s", level, "", t, #name, buf);
#define VOID(name) \
     debug("gw.msg", 0, "%*s %s.%s: %p", level, "", t, #name, p->name);
#define MSG(tt, stmt) \
    if (tt == msg->type) \
        { char *t = #tt; struct tt *p = &msg->tt; stmt }
#include "msg-decl.h"
    debug("gw.msg", 0, "Msg object ends.");
}

msg_duplicate()

Msg* msg_duplicate

(

Msg *

msg

)

Definition at line 111 of file msg.c.

References msg, and msg_create.

Referenced by add_msg_cb(), at2_add_msg_cb(), bb_smscconn_receive_internal(), bearerbox_to_smsbox(), boxc_sent_push(), catenate_msg(), cgw_add_msg_cb(), cimd2_add_msg_cb(), concat_handling_check_and_handle(), concat_handling_clear_old_parts(), generic_receive_sms(), handle_pdu(), httpsmsc_send(), main(), main_connection_loop(), msg_cb(), oisd_add_msg_cb(), run_batch(), send_message(), send_msg_cb(), sms_split(), smsbox_to_bearerbox(), smsc2_rout(), smscconn_send(), soap_add_msg_cb(), store_to_dict(), wrapper_add_msg(), and wrapper_sender().

{
    Msg *new;

    new = msg_create(msg->type);

#define INTEGER(name) p->name = q->name;
#define OCTSTR(name) \
    if (q->name == NULL) p->name = NULL; \
    else p->name = octstr_duplicate(q->name);
#define UUID(name) uuid_copy(p->name, q->name);
#define VOID(name) p->name = q->name;
#define MSG(type, stmt) { \
    struct type *p = &new->type; \
    struct type *q = &msg->type; \
    stmt }
#include "msg-decl.h"

    return new;
}

msg_pack()

Octstr* msg_pack

(

Msg *

msg

)

Definition at line 181 of file msg.c.

References append_integer(), msg, octstr_create, and panic.

Referenced by deliver_to_bearerbox_real(), init_bearerbox(), init_smppbox(), main(), send_msg(), send_pdu(), smsbox_thread(), and write_to_bearerbox_real().

{
    Octstr *os;

    os = octstr_create("");
    append_integer(os, msg->type);

#define INTEGER(name) append_integer(os, p->name);
#define OCTSTR(name) append_string(os, p->name);
#define UUID(name) append_uuid(os, p->name);
#define VOID(name)
#define MSG(type, stmt) \
    case type: { struct type *p = &msg->type; stmt } break;

    switch (msg->type) {
#include "msg-decl.h"
    default:
        panic(0, "Internal error: unknown message type: %d",
              msg->type);
    }

    return os;
}

msg_type()

enum msg_type msg_type

(

Msg *

msg

)

Definition at line 176 of file msg.c.

References msg.

{
    return msg->type;
}

msg_unpack_real()

Msg* msg_unpack_real	(	Octstr *	os,
		const char *	file,
		long	line,
		const char *	func
	)

Definition at line 206 of file msg.c.

References error(), file, msg, msg_create_real(), msg_destroy(), and parse_integer().

{
    Msg *msg;
    int off;
    long i;

    msg = msg_create_real(0, file, line, func);
    if (msg == NULL)
        goto error;

    off = 0;

    if (parse_integer(&i, os, &off) == -1)
        goto error;
    msg->type = i;

#define INTEGER(name) \
    if (parse_integer(&(p->name), os, &off) == -1) goto error;
#define OCTSTR(name) \
    if (parse_string(&(p->name), os, &off) == -1) goto error;
#define UUID(name) \
    if (parse_uuid(p->name, os, &off) == -1) goto error;
#define VOID(name)
#define MSG(type, stmt) \
    case type: { struct type *p = &(msg->type); stmt } break;

    switch (msg->type) {
#include "msg-decl.h"
    default:
        error(0, "Internal error: unknown message type: %d",
              msg->type);
        msg->type = 0;
        msg_destroy(msg);
        return NULL;
    }

    return msg;

error:
    if (msg != NULL) msg_destroy(msg);
    error(0, "Msg packet was invalid.");
    return NULL;
}

msg_unpack_wrapper()

Msg* msg_unpack_wrapper ( Octstr *  os )

inline

Definition at line 256 of file msg.c.

References msg_unpack.

Referenced by init_bearerbox(), init_smppbox(), and main().

{
    return msg_unpack(os);
}