Vortex Channel: Related function to create and manage Vortex Channels.


Functions

gboolean vortex_channel_close (VortexChannel *channel, VortexOnClosedNotification on_closed)
 Close the given channel.
WaitReplyDatavortex_channel_create_wait_reply ()
 Creates a new wait reply to be used to wait for a specific reply.
gboolean vortex_channel_finalize_ans_rpy (VortexChannel *channel, gint msg_no_rpy)
 Allows to finalize the series of ANS reply already sent with a NUL reply.
void vortex_channel_free (VortexChannel *channel)
 free channel allocated resources.
void vortex_channel_free_wait_reply (WaitReplyData *wait_reply)
 Frees allocated memory by wait reply data.
VortexConnectionvortex_channel_get_connection (VortexChannel *channel)
 Returns actual channel session (or Vortex Connection).
gpointer vortex_channel_get_data (VortexChannel *channel, gpointer key)
 Returns the value indexed by the given key inside the given channel.
gchar * vortex_channel_get_mime_type (VortexChannel *channel)
 Returns current mime type used for messages exchange perform on the given channel.
guint32 vortex_channel_get_next_ans_no (VortexChannel *channel)
 Gets next ansno number to be used for the next message to be sent.
guint32 vortex_channel_get_next_expected_ans_no (VortexChannel *channel)
 Returns the next expected ansno number message to be received.
gint vortex_channel_get_next_expected_msg_no (VortexChannel *channel)
 Returns actual message number expected to be received on this channel.
gint vortex_channel_get_next_expected_reply_no (VortexChannel *channel)
 Returns actual reply number expected to be received from remote peer.
guint32 vortex_channel_get_next_expected_seq_no (VortexChannel *channel)
 Returns actual seq no expected to be received on this channel.
gint vortex_channel_get_next_msg_no (VortexChannel *channel)
 Returns the next message number to be used on this channel.
gint vortex_channel_get_next_reply_no (VortexChannel *channel)
 Returns actual reply number to be used.
guint32 vortex_channel_get_next_seq_no (VortexChannel *channel)
 Returns next sequence number to be used.
gint vortex_channel_get_number (VortexChannel *channel)
 Returns the channel number for selected channel.
VortexFramevortex_channel_get_piggyback (VortexChannel *channel)
 Allows to get initial piggyback received on the channel start reply.
gchar * vortex_channel_get_profile (VortexChannel *channel)
 Returns the current profile the channel is running.
VortexFramevortex_channel_get_reply (VortexChannel *channel, GAsyncQueue *queue)
 Allows to get the next frame received on the given channel due to channel start reply piggybacking or due to a frame received while using the function vortex_channel_queue_reply as a frame received handler.
gchar * vortex_channel_get_transfer_encoding (VortexChannel *channel)
 Returns current content transfer encoding used for messages exchange perform on the given channel.
gint vortex_channel_get_window_size (VortexChannel *channel)
 Returns actual channel window size.
gboolean vortex_channel_have_complete_flag (VortexChannel *channel)
 Allows to get actual complete flag status for the given channel.
gboolean vortex_channel_have_piggyback (VortexChannel *channel)
 Allows to check if the given channel have piggyback waiting to be processed.
gboolean vortex_channel_is_being_closed (VortexChannel *channel)
 Return if a channel is on the process of being closed.
gboolean vortex_channel_is_defined_close_handler (VortexChannel *channel)
 Returns if the given channel have defined its close handler.
gboolean vortex_channel_is_defined_received_handler (VortexChannel *channel)
 Return whenever the received handler have been defined for this channel.
gboolean vortex_channel_is_opened (VortexChannel *channel)
 Return channel opened state.
gboolean vortex_channel_is_ready (VortexChannel *channel)
 Returns the actual state for a given channel about pending replies.
gboolean vortex_channel_is_running_profile (VortexChannel *channel, gchar *profile)
 Allows to check if the given channel is running a particular profile.
VortexChannelvortex_channel_new (VortexConnection *connection, gint channel_num, gchar *profile, VortexOnCloseChannel close, gpointer close_user_data, VortexOnFrameReceived received, gpointer received_user_data, VortexOnChannelCreated on_channel_created, gpointer user_data)
 Creates a new channel over the given connection.
VortexChannelvortex_channel_new_full (VortexConnection *connection, gint channel_num, gchar *serverName, gchar *profile, VortexEncoding encoding, gchar *profile_content, gint profile_content_size, VortexOnCloseChannel close, gpointer close_user_data, VortexOnFrameReceived received, gpointer received_user_data, VortexOnChannelCreated on_channel_created, gpointer user_data)
 Extended version for vortex_channel_new, supporting all options available while creating new channels.
VortexChannelvortex_channel_new_fullv (VortexConnection *connection, gint channel_num, gchar *serverName, gchar *profile, VortexEncoding encoding, VortexOnCloseChannel close, gpointer close_user_data, VortexOnFrameReceived received, gpointer received_user_data, VortexOnChannelCreated on_channel_created, gpointer user_data, gchar *profile_content_format,...)
 Allows to create a new channel using all possible option and making possible to define profile content using a printf-like syntax.
void vortex_channel_queue_reply (VortexChannel *channel, VortexConnection *connection, VortexFrame *frame, gpointer user_data)
 Support function that could be used as a frame received function which queue all frames received inside a GAsyncQueue.
gboolean vortex_channel_send_ans_rpy (VortexChannel *channel, gchar *message, gint message_size, gint msg_no_rpy)
 Allows to perform an ANS/NUL reply to a given MSG frame received.
gboolean vortex_channel_send_ans_rpyv (VortexChannel *channel, gint msg_no_rpy, gchar *format,...)
 Allows to send ANS message reply using stdargs argument.
gboolean vortex_channel_send_err (VortexChannel *channel, gchar *message, gint message_size, gint msg_no_rpy)
 Allows to reply a message using ERR message type.
gboolean vortex_channel_send_errv (VortexChannel *channel, gint msg_no_err, gchar *format,...)
 Printf-like version for vortex_channel_send_err.
gboolean vortex_channel_send_msg (VortexChannel *channel, gchar *message, gint message_size, gint *msg_no)
 Allows to send a message.
gboolean vortex_channel_send_msg_and_wait (VortexChannel *channel, gchar *message, gint message_size, gint *msg_no, WaitReplyData *wait_reply)
 Allows to send a message and start a wait reply.
gboolean vortex_channel_send_msg_and_waitv (VortexChannel *channel, gint *msg_no, WaitReplyData *wait_reply, gchar *format,...)
 Printf-like version for the vortex_channel_send_msg_and_wait function.
gboolean vortex_channel_send_msgv (VortexChannel *channel, gint *msg_no, gchar *format,...)
 Allows to send message using a printf-like format.
gboolean vortex_channel_send_rpy (VortexChannel *channel, gchar *message, gint message_size, gint msg_no_rpy)
 Allows to send a message reply using RPY type.
gboolean vortex_channel_send_rpyv (VortexChannel *channel, gint msg_no_rpy, gchar *format,...)
 printf-like version for vortex_channel_send_rpy function.
void vortex_channel_set_close_handler (VortexChannel *channel, VortexOnCloseChannel close, gpointer user_data)
 Allows to set close channel to the given channel.
void vortex_channel_set_complete_flag (VortexChannel *channel, gboolean value)
 Allows to set complete frames flag.
void vortex_channel_set_data (VortexChannel *channel, gpointer key, gpointer value)
 Allows to store a pair key/value into the channel.
void vortex_channel_set_received_handler (VortexChannel *channel, VortexOnFrameReceived received, gpointer user_data)
 Allows to set the frame received handler.
gboolean vortex_channel_validate_err (VortexFrame *frame, gchar **code, gchar **msg)
 Validates err message received from remote peer.
VortexFramevortex_channel_wait_reply (VortexChannel *channel, gint msg_no, WaitReplyData *wait_reply)
 Allows caller to wait for a particular reply to be received.