mirror of git://git.psyc.eu/libpsyc
59 lines
1.4 KiB
D
59 lines
1.4 KiB
D
module psyc.render;
|
|
|
|
import psyc.packet;
|
|
|
|
|
|
extern (C):
|
|
|
|
/*
|
|
* All rendering functions and the definitions they use are defined here.
|
|
*/
|
|
|
|
/**
|
|
* Return codes for psyc_render.
|
|
*/
|
|
enum RenderRC
|
|
{
|
|
/// Error, method is missing, but data is present.
|
|
ERROR_METHOD_MISSING = -3,
|
|
/// Error, a modifier name is missing.
|
|
ERROR_MODIFIER_NAME_MISSING = -2,
|
|
/// Error, buffer is too small to render the packet.
|
|
ERROR = -1,
|
|
/// Packet is rendered successfully in the buffer.
|
|
SUCCESS = 0,
|
|
} ;
|
|
|
|
/**
|
|
* Return codes for psyc_render_list.
|
|
*/
|
|
enum RenderListRC
|
|
{
|
|
/// Error, buffer is too small to render the list.
|
|
ERROR = -1,
|
|
/// List is rendered successfully in the buffer.
|
|
SUCCESS = 0,
|
|
};
|
|
|
|
/**
|
|
* Render a PSYC packet into a buffer.
|
|
*
|
|
* The packet structure should contain the packet parts, either routing, entity,
|
|
* method & data, or routing & content when rendering raw content.
|
|
* It should also contain the contentLength & total length of the packet,
|
|
* you can use psyc_packet_length_set() for calculating & setting these values.
|
|
* This function renders packet->length bytes to the buffer,
|
|
* if buflen is less than that an error is returned.
|
|
*
|
|
* @see psyc_packet_new
|
|
* @see psyc_packet_new_raw
|
|
* @see psyc_packet_length_set
|
|
*/
|
|
RenderRC psyc_render (Packet *packet, ubyte *buffer, size_t buflen);
|
|
|
|
/**
|
|
* Render a PSYC list into a buffer.
|
|
*/
|
|
RenderListRC psyc_render_list (List *list, ubyte *buffer, size_t buflen);
|
|
|