1
0
Fork 0
mirror of git://git.psyc.eu/libpsyc synced 2024-08-15 03:19:02 +00:00
libpsyc/include/psyc/packet.h

181 lines
4.9 KiB
C
Raw Normal View History

#ifndef PSYC_PACKET_H
2011-05-09 12:37:57 +00:00
/**
* @file psyc/packet.h
* @brief Interface for PSYC packet data structures.
*
* Packet data structures and functions for creating them are defined here.
*/
/**
* @defgroup packet Packet data structures
*
* This module contains definitions of packet data structures and functions for
* creating them.
* @{
*/
#include <psyc.h>
#include <psyc/syntax.h>
2011-05-09 14:32:39 +00:00
/** Modifier flags. */
typedef enum
{
2011-05-09 14:32:39 +00:00
/// Modifier needs to be checked if it needs length.
PSYC_MODIFIER_CHECK_LENGTH = 0,
2011-05-09 14:32:39 +00:00
/// Modifier needs length.
PSYC_MODIFIER_NEED_LENGTH = 1,
2011-05-09 14:32:39 +00:00
/// Modifier doesn't need length.
PSYC_MODIFIER_NO_LENGTH = 2,
2011-05-09 14:32:39 +00:00
/// Routing modifier, which implies that it doesn't need length.
PSYC_MODIFIER_ROUTING = 3,
} psycModifierFlag;
2011-05-09 14:32:39 +00:00
/** List flags. */
typedef enum
{
2011-05-09 14:32:39 +00:00
/// List needs to be checked if it needs length.
PSYC_LIST_CHECK_LENGTH = 0,
2011-05-09 14:32:39 +00:00
/// List needs length.
PSYC_LIST_NEED_LENGTH = 1,
2011-05-09 14:32:39 +00:00
/// List doesn't need length.
PSYC_LIST_NO_LENGTH = 2,
} psycListFlag;
2011-05-09 14:32:39 +00:00
/** Packet flags. */
typedef enum
{
2011-05-09 14:32:39 +00:00
/// Packet needs to be checked if it needs content length.
PSYC_PACKET_CHECK_LENGTH = 0,
2011-05-09 14:32:39 +00:00
/// Packet needs content length.
PSYC_PACKET_NEED_LENGTH = 1,
2011-05-09 14:32:39 +00:00
/// Packet doesn't need content length.
PSYC_PACKET_NO_LENGTH = 2,
} psycPacketFlag;
2011-05-09 14:32:39 +00:00
/** Structure for a modifier. */
typedef struct
2011-05-09 15:06:15 +00:00
{
char oper;
psycString name;
psycString value;
psycModifierFlag flag;
} psycModifier;
2011-05-09 14:32:39 +00:00
/** Structure for an entity or routing header. */
typedef struct
{
size_t lines;
psycModifier *modifiers;
} psycHeader;
2011-05-09 14:32:39 +00:00
/** Structure for a list. */
typedef struct
{
size_t num_elems;
psycString *elems;
size_t length;
psycListFlag flag;
} psycList;
/** intermediate struct for a PSYC packet */
typedef struct
{
psycHeader routing; ///< Routing header.
psycHeader entity; ///< Entity header.
2011-05-09 14:32:39 +00:00
psycString method; ///< Contains the method.
psycString data; ///< Contains the data.
psycString content; ///< Contains the whole content.
size_t routingLength; ///< Length of routing part.
size_t contentLength; ///< Length of content part.
size_t length; ///< Total length of packet.
2011-05-09 14:32:39 +00:00
psycPacketFlag flag; ///< Packet flag.
} psycPacket;
2011-05-09 14:32:39 +00:00
/** Check if a modifier needs length. */
static inline
psycModifierFlag psyc_checkModifierLength (psycModifier *m)
{
psycModifierFlag flag;
if (m->value.length > PSYC_MODIFIER_SIZE_THRESHOLD)
flag = PSYC_MODIFIER_NEED_LENGTH;
else if (memchr(m->value.ptr, (int)'\n', m->value.length))
flag = PSYC_MODIFIER_NEED_LENGTH;
else
flag = PSYC_MODIFIER_NO_LENGTH;
return flag;
}
2011-05-09 14:32:39 +00:00
/** Create new modifier. */
static inline
psycModifier psyc_newModifier (char oper, psycString *name, psycString *value,
psycModifierFlag flag)
{
psycModifier m = {oper, *name, *value, flag};
if (flag == PSYC_MODIFIER_CHECK_LENGTH) // find out if it needs a length
m.flag = psyc_checkModifierLength(&m);
return m;
}
/** Create new modifier */
static inline
psycModifier psyc_newModifier2 (char oper,
const char *name, size_t namelen,
const char *value, size_t valuelen,
psycModifierFlag flag)
{
psycString n = {namelen, name};
psycString v = {valuelen, value};
return psyc_newModifier(oper, &n, &v, flag);
}
2011-05-09 14:32:39 +00:00
/** Get the total length of a modifier when rendered. */
size_t psyc_getModifierLength (psycModifier *m);
2011-05-09 14:32:39 +00:00
/** Check if a list needs length. */
psycListFlag psyc_checkListLength (psycList *list);
2011-05-09 14:32:39 +00:00
/** Get the total length of a list when rendered. */
psycListFlag psyc_getListLength (psycList *list);
2011-05-09 14:32:39 +00:00
/** Check if a packet needs length. */
psycPacketFlag psyc_checkPacketLength (psycPacket *p);
2011-05-09 14:32:39 +00:00
/** Calculate and set the rendered length of packet parts and total packet length. */
size_t psyc_setPacketLength (psycPacket *p);
2011-05-09 14:32:39 +00:00
/** Create new list. */
psycList psyc_newList (psycString *elems, size_t num_elems, psycListFlag flag);
2011-05-09 14:32:39 +00:00
/** Create new packet. */
psycPacket psyc_newPacket (psycHeader *routing,
psycHeader *entity,
psycString *method, psycString *data,
psycPacketFlag flag);
2011-05-09 14:32:39 +00:00
/** Create new packet. */
psycPacket psyc_newPacket2 (psycModifier *routing, size_t routinglen,
psycModifier *entity, size_t entitylen,
const char *method, size_t methodlen,
const char *data, size_t datalen,
psycPacketFlag flag);
2011-05-09 14:32:39 +00:00
/** Create new packet with raw content. */
2011-05-05 22:18:25 +00:00
psycPacket psyc_newRawPacket (psycHeader *routing, psycString *content,
psycPacketFlag flag);
2011-05-09 14:32:39 +00:00
/** Create new packet with raw content. */
2011-05-05 22:18:25 +00:00
psycPacket psyc_newRawPacket2 (psycModifier *routing, size_t routinglen,
const char *content, size_t contentlen,
psycPacketFlag flag);
2011-05-09 12:37:57 +00:00
/** @} */ // end of packet group
2011-05-09 07:02:15 +00:00
#define PSYC_PACKET_H
#endif