Declaration of pointers to serial client interface's methods.
Public Attributes#
Pointer to implementation-depended method which send data in "buffer_to_send" with size "buffer_size" over serial connection to host.
Fetches frame if one was received.
Pointer to implementation-depended method which executes routine to sustain connection with the host.
Pointer to implementation-depended method.
Pointer to implementation-depended method which free memory taken by specific instance.
Public Attribute Documentation#
send#
sid_error_t(* sid_pal_serial_ifc_s::send) (const sid_pal_serial_ifc_t *_this, const uint8_t *frame_to_send, size_t frame_size)
Pointer to implementation-depended method which send data in "buffer_to_send" with size "buffer_size" over serial connection to host.
Returns
SID_ERROR_NONE - in case method finished with success. In case of error the error's type depend upon implementation.
get_frame#
sid_error_t(* sid_pal_serial_ifc_s::get_frame) (const sid_pal_serial_ifc_t *_this, uint8_t **frame_received, size_t *frame_size)
Fetches frame if one was received.
It is advisable to copy it instantaneously, since there is no guaranty that frame won't be corrupted or erased after call of this function finished.
Returns
Any other error possible if function not succeeded to execute properly.
process#
sid_error_t(* sid_pal_serial_ifc_s::process) (const sid_pal_serial_ifc_t *_this)
Pointer to implementation-depended method which executes routine to sustain connection with the host.
get_mtu#
sid_error_t(* sid_pal_serial_ifc_s::get_mtu) (const sid_pal_serial_ifc_t *_this, uint16_t *mtu)
Pointer to implementation-depended method.
It retrieves mtu (maximum transmit unit).
destroy#
void(* sid_pal_serial_ifc_s::destroy) (const sid_pal_serial_ifc_t *_this)
Pointer to implementation-depended method which free memory taken by specific instance.