ratp_link_new_tty ()

ratp_link_t *
ratp_link_new_tty (const char *path,
                   speed_t speed,
                   uint8_t mdl);

Create a new RATP link associated to a TTY.

ratp_link_new_fifo ()

ratp_link_t *
ratp_link_new_fifo (const char *path_in,
                    const char *path_out,
                    uint8_t mdl);

Create a new RATP link associated to a pair of input/output FIFOs.

ratp_link_free ()

void
ratp_link_free (ratp_link_t *self);

Dispose a ratp_link_t.

ratp_link_initialize ()

ratp_status_t
ratp_link_initialize (ratp_link_t *self);

Initialize a RATP link.

This operation just opens and sets up the physical channel, it doesn't send or receive any RATP packet.

ratp_link_get_initialized ()

bool
ratp_link_get_initialized (ratp_link_t *self);

Checks whether the RATP link is initialized.

ratp_link_shutdown ()

void
ratp_link_shutdown (ratp_link_t *self);

Shutdown a RATP link.

This operation closes the physical channel.

ratp_link_initialized_func ()

void
(*ratp_link_initialized_func) (ratp_link_t *self,
                               void *user_data);

Handler used to report initialization to the user.

ratp_link_set_initialized_callback ()

void
ratp_link_set_initialized_callback (ratp_link_t *self,
                                    ratp_link_initialized_func callback,
                                    void *user_data);

Set the callback to be called when the RATP link is initialized.

The callback is guaranteed to be called from within the link management thread.

ratp_link_state_str ()

const char *
ratp_link_state_str (ratp_link_state_t state);

Gets a description for the given ratp_link_state_t.

ratp_link_get_state ()

ratp_link_state_t
ratp_link_get_state (ratp_link_t *self);

Gets the current state of the RATP link.

ratp_link_state_update_func ()

void
(*ratp_link_state_update_func) (ratp_link_t *self,
                                ratp_link_state_t old_state,
                                ratp_link_state_t new_state,
                                ratp_status_t status_reason,
                                void *user_data);

Handler used to report state updates to the user.

ratp_link_set_state_update_callback ()

void
ratp_link_set_state_update_callback (ratp_link_t *self,
                                     ratp_link_state_update_func callback,
                                     void *user_data);

Set the callback to be called when RATP link state updates happen.

ratp_link_active_open ()

ratp_status_t
ratp_link_active_open (ratp_link_t *self);

Requests to actively open the RATP link.

This method does not wait for the RATP link to be established, it just schedules the request. Link state updates may be monitored with the callback configured via ratp_link_set_state_update_callback().

ratp_link_active_open_sync ()

ratp_status_t
ratp_link_active_open_sync (ratp_link_t *self,
                            unsigned long  timeout_ms);

Requests to actively open the RATP link.

This method blocks until the RATP link is established or until timeout_ms are elapsed.

Monitoring of the link state with ratp_link_set_state_update_callback() cannot be performed while this operation is ongoing; any callback previously configured will be ignored.

ratp_link_passive_open ()

ratp_status_t
ratp_link_passive_open (ratp_link_t *self);

Requests to passively open the RATP link.

This method does not wait for the RATP link to be established, it just schedules the request. Link state updates may be monitored with the callback configured via ratp_link_set_state_update_callback().

ratp_link_close ()

void
ratp_link_close (ratp_link_t *self);

Requests to close the RATP link.

This method does not wait for the RATP link to be closed, it just schedules the request. Link state updates may be monitored with the callback configured via ratp_link_set_state_update_callback().

ratp_link_close_sync ()

ratp_status_t
ratp_link_close_sync (ratp_link_t *self,
                      unsigned long  timeout_ms);

Requests to close the RATP link.

This method blocks until the RATP link is established or until timeout_ms are elapsed.

Monitoring of the link state with ratp_link_set_state_update_callback() cannot be performed while this operation is ongoing; any callback previously configured will be ignored.

ratp_link_send_ready_func ()

void
(*ratp_link_send_ready_func) (ratp_link_t *self,
                              ratp_status_t status_reason,
                              void *user_data);

Handler used to report when a sent buffer has been completely sent.

ratp_link_send ()

ratp_status_t
ratp_link_send (ratp_link_t *self,
                unsigned long  timeout_ms,
                const uint8_t *buffer,
                size_t buffer_size,
                ratp_link_send_ready_func callback,
                void *user_data);

Schedules the data in buffer to be sent. If the link is not yet established, it will be sent as soon as the establishment is finished.

When all the data is sent and acknowledged by the peer, or if any error happens (timeout included), callback will be called to inform the user of the operation result.

ratp_link_receive_ready_func ()

void
(*ratp_link_receive_ready_func) (ratp_link_t *self,
                                 const uint8_t *buffer,
                                 size_t buffer_size,
                                 void *user_data);

Handler used to report data received to the user.

ratp_link_set_receive_callback ()

void
ratp_link_set_receive_callback (ratp_link_t *self,
                                ratp_link_receive_ready_func callback,
                                void *user_data);

Set the callback to be called when data is received in the RATP link.

ratp_link_t

typedef struct ratp_link_s ratp_link_t;

This is an opaque type representing a RATP link.

enum ratp_link_state_t

State of the RATP link.