Vortex Frame Factory: Function to manipulate frames inside Vortex Library


Functions

gboolean vortex_frame_are_equal (VortexFrame *a, VortexFrame *b)
 Allows to check if the given frames are equal.
gboolean vortex_frame_are_joinable (VortexFrame *a, VortexFrame *b)
 Allows to check if the given frames are joinable or the first one follows the next.
gchar * vortex_frame_build_up_from_params (VortexFrameType type, gint32 channel, gint32 msgno, gboolean more, guint32 seqno, gint32 size, gint32 ansno, gchar *payload)
 Builds a frame using the given parameters.
gchar * vortex_frame_build_up_from_params_s (VortexFrameType type, gint32 channel, gint32 msgno, gboolean more, guint32 seqno, gint32 size, gint32 ansno, gchar *content_type, gchar *transfer_encoding, gchar *payload, gint *frame_size)
 Creates a new frame from using the given data and returning current frame size resulting from the operation.
VortexFramevortex_frame_copy (VortexFrame *frame)
 Perform a copy from the received frame.
VortexFramevortex_frame_create (VortexFrameType type, gint32 channel, gint32 msgno, gboolean more, guint32 seqno, gint32 size, gint32 ansno, gchar *payload)
 Creates a new frame object (VortexFrame) using the given data.
VortexFramevortex_frame_create_full (VortexFrameType type, gint32 channel, gint32 msgno, gboolean more, guint32 seqno, gint32 size, gint32 ansno, gchar *content_type, gchar *transfer_encoding, gchar *payload)
 Creates a new frame as vortex_frame_create but also allowing to specify mime header content, that is, Content-Type and Content-Transfer-Encoding values.
void vortex_frame_free (VortexFrame *frame)
 Deallocate the frame.
gint vortex_frame_get_ansno (VortexFrame *frame)
 Returns current ans number for the given frame.
gint vortex_frame_get_channel (VortexFrame *frame)
 Returns current channel used to sent or receive the given frame.
gchar * vortex_frame_get_close_message (gint number, gchar *code, gchar *xml_lang, gchar *close_content)
 Creates and return the close message.
gint vortex_frame_get_content_size (VortexFrame *frame)
 Allows to get current frame content size, including payload and mime headers.
gchar * vortex_frame_get_content_type (VortexFrame *frame)
 Returns frame content type.
gchar * vortex_frame_get_error_message (gchar *code, gchar *error_content, gchar *xml_lang)
 Creates and return the error message.
gint vortex_frame_get_id (VortexFrame *frame)
 Allows to get the unique frame identifier for the given frame.
gint vortex_frame_get_mime_header_size (VortexFrame *frame)
 Allows to get current status of the mime header size for the given frame.
gint vortex_frame_get_more_flag (VortexFrame *frame)
 Returns actual more flag status for the given frame.
gint vortex_frame_get_msgno (VortexFrame *frame)
 Return current message number used for the given frame.
gchar * vortex_frame_get_ok_message ()
 Returns the ok message.
gchar * vortex_frame_get_payload (VortexFrame *frame)
 Returns the payload the given frame have.
gint vortex_frame_get_payload_size (VortexFrame *frame)
 Returns the current payload size the given frame have without taking into account mime headers.
gchar * vortex_frame_get_raw_frame (VortexFrame *frame)
 Returns the frame in plain text form from a VortexFrame object.
gint vortex_frame_get_seqno (VortexFrame *frame)
 Returns the current sequence number for the given frame.
gchar * vortex_frame_get_start_message (gint channel_num, gchar *serverName, gchar *profile, VortexEncoding encoding, gchar *content_profile, gint profile_content_size)
 Creates and return an new start message using the given data.
gchar * vortex_frame_get_start_rpy_message (gchar *profile, gchar *profile_content)
 Allows to create and return a start reply message.
gchar * vortex_frame_get_transfer_encoding (VortexFrame *frame)
 Allows to get current Content-Transfer-Encoding mime header configuration for the given frame (if defined).
VortexFrameType vortex_frame_get_type (VortexFrame *frame)
 return actual frame type.
gboolean vortex_frame_is_error_message (VortexFrame *frame, gchar **code, gchar **message)
 Allows to check if the given frame contains an error message inside the frame payload.
VortexFramevortex_frame_join (VortexFrame *a, VortexFrame *b)
 Allows to join two frames into a newly allocated one.
gchar * vortex_frame_seq_build_up_from_params (gint channel_num, gint ackno, gint window_size)
 Allows to create a new SEQ frame.