RRManager

Name

RRManager -- 

Synopsis



enum        RRManagerState;
RRManager*  rr_manager_new                  (gint id);
RRChannel*  rr_manager_start                (RRManager *manager,
                                             const gchar *server_name,
                                             GType channel_type,
                                             gpointer config_data,
                                             GError **error);
RRChannel*  rr_manager_start_multi          (RRManager *manager,
                                             const gchar *server_name,
                                             GError **error,
                                             ...);
RRChannel*  rr_manager_start_multiv         (RRManager *manager,
                                             const gchar *server_name,
                                             GError **error,
                                             va_list args);
gboolean    rr_manager_close_channel        (RRManager *manager,
                                             RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic,
                                             GError **error);
gboolean    rr_manager_close_channel_nonblock
                                            (RRManager *manager,
                                             RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic,
                                             GError **error);
gboolean    rr_manager_wait_for_greeting    (RRManager *manager,
                                             GError **error);
gboolean    rr_manager_wait_for_greeting_sent
                                            (RRManager *manager,
                                             GError **error);
gboolean    rr_manager_send_greeting        (RRManager *manager,
                                             GError **error);
void        rr_manager_set_expects_greeting (RRManager *manager,
                                             gboolean state);
void        rr_manager_set_greeting_sent    (RRManager *manager,
                                             gboolean state);

Description

Details

enum RRManagerState

typedef enum {
	RR_MANAGER_NORMAL,
	RR_MANAGER_STARTING,
	RR_MANAGER_CLOSING
} RRManagerState;


rr_manager_new ()

RRManager*  rr_manager_new                  (gint id);

id :

Returns :


rr_manager_start ()

RRChannel*  rr_manager_start                (RRManager *manager,
                                             const gchar *server_name,
                                             GType channel_type,
                                             gpointer config_data,
                                             GError **error);

Tries to create a new channel of the provided profile type.

manager :

The RRManager.

server_name :

# The server_name parameter or NULL.

channel_type :

config_data :

Profile specific config data or NULL.

error :

location to return an error of type RR_ERROR or RR_BEEP_ERROR

Returns :

A RRProfile on success, NULL on failure.


rr_manager_start_multi ()

RRChannel*  rr_manager_start_multi          (RRManager *manager,
                                             const gchar *server_name,
                                             GError **error,
                                             ...);

Tries to create a new channel with one of the provided profiles.

manager :

The RRManager.

server_name :

The server_name parameter or NULL.

error :

location to return an error of type RR_ERROR or RR_BEEP_ERROR

... :

A list of Profile type + config_data pairs and a G_TYPE_INVALID at the end.

Returns :

A RRProfile on success, NULL on failure.


rr_manager_start_multiv ()

RRChannel*  rr_manager_start_multiv         (RRManager *manager,
                                             const gchar *server_name,
                                             GError **error,
                                             va_list args);

manager :

server_name :

error :

args :

Returns :


rr_manager_close_channel ()

gboolean    rr_manager_close_channel        (RRManager *manager,
                                             RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic,
                                             GError **error);

manager :

A RRManager

channel :

The channel/profile to close

code :

a three-digit reply code meaningful to programs

xml_lang :

diagnostic :

A textual message that is meaningful to implementers but not programs.

error :

location to return an error of type RR_ERROR or RR_BEEP_ERROR

Returns :

TRUE on success, FALSE on failure.


rr_manager_close_channel_nonblock ()

gboolean    rr_manager_close_channel_nonblock
                                            (RRManager *manager,
                                             RRChannel *channel,
                                             gint code,
                                             const gchar *xml_lang,
                                             const gchar *diagnostic,
                                             GError **error);

manager :

channel :

code :

xml_lang :

diagnostic :

error :

Returns :


rr_manager_wait_for_greeting ()

gboolean    rr_manager_wait_for_greeting    (RRManager *manager,
                                             GError **error);

Blocks until a greeting message is received.

manager :

the manager channel.

error :

location to return an error of type RR_ERROR or RR_BEEP_ERROR.

Returns :

TRUE on success, FALSE on failure.


rr_manager_wait_for_greeting_sent ()

gboolean    rr_manager_wait_for_greeting_sent
                                            (RRManager *manager,
                                             GError **error);

manager :

error :

Returns :


rr_manager_send_greeting ()

gboolean    rr_manager_send_greeting        (RRManager *manager,
                                             GError **error);

Resets in_seq and msgno for the manager channel to 0 and sends a new greeting.

manager :

the manager channel.

error :

location to return an error of type RR_ERROR or RR_BEEP_ERROR.

Returns :

TRUE on success, FALSE on failure.


rr_manager_set_expects_greeting ()

void        rr_manager_set_expects_greeting (RRManager *manager,
                                             gboolean state);

Selects if the manager is expecting an incoming greeting.

manager :

the manager channel.

state :

TRUE if a greeting is expected, FALSE if not.


rr_manager_set_greeting_sent ()

void        rr_manager_set_greeting_sent    (RRManager *manager,
                                             gboolean state);

Checks if a greeting has been sent.

manager :

the manager channel.

state :

TRUE if a greeting is sent, FALSE if not.