Opaque structure representing a handle of a device. More...
Data Fields | |
| uint8_t * | buffer |
| Buffer for write and read operations. More... | |
| size_t | buffer_size |
| Buffer size. More... | |
| size_t | bytes_available |
| Number of bytes available in the buffer to be read. More... | |
| struct jaylink_device * | dev |
| Device instance. More... | |
| size_t | read_length |
| Number of bytes left for the read operation. More... | |
| size_t | read_pos |
| Current read position in the buffer. More... | |
| int | sock |
| Socket descriptor. More... | |
| size_t | write_length |
| Number of bytes left to be written before the write operation will be performed. More... | |
| size_t | write_pos |
| Current write position in the buffer. More... | |
Detailed Description
Opaque structure representing a handle of a device.
Definition at line 153 of file libjaylink-internal.h.
Field Documentation
◆ buffer
| uint8_t* jaylink_device_handle::buffer |
Buffer for write and read operations.
Note that write and read operations are always processed consecutively and therefore the same buffer can be used for both.
Definition at line 162 of file libjaylink-internal.h.
Referenced by adjust_buffer(), cleanup_handle(), initialize_handle(), transport_tcp_read(), transport_tcp_start_write(), transport_tcp_start_write_read(), transport_tcp_write(), transport_usb_read(), and transport_usb_write().
◆ buffer_size
| size_t jaylink_device_handle::buffer_size |
Buffer size.
Definition at line 164 of file libjaylink-internal.h.
Referenced by adjust_buffer(), initialize_handle(), transport_tcp_write(), and transport_usb_write().
◆ bytes_available
| size_t jaylink_device_handle::bytes_available |
Number of bytes available in the buffer to be read.
Definition at line 168 of file libjaylink-internal.h.
Referenced by initialize_handle(), transport_tcp_read(), transport_tcp_start_read(), transport_tcp_start_write_read(), transport_usb_read(), transport_usb_start_read(), and transport_usb_start_write_read().
◆ dev
| struct jaylink_device* jaylink_device_handle::dev |
Device instance.
Definition at line 155 of file libjaylink-internal.h.
Referenced by _recv(), _send(), adjust_buffer(), allocate_device_handle(), free_device_handle(), handle_server_hello(), initialize_handle(), jaylink_clear_reset(), jaylink_emucom_read(), jaylink_emucom_write(), jaylink_file_delete(), jaylink_file_get_size(), jaylink_file_read(), jaylink_file_write(), jaylink_get_available_interfaces(), jaylink_get_caps(), jaylink_get_counters(), jaylink_get_device(), jaylink_get_extended_caps(), jaylink_get_firmware_version(), jaylink_get_free_memory(), jaylink_get_hardware_info(), jaylink_get_hardware_status(), jaylink_get_hardware_version(), jaylink_get_selected_interface(), jaylink_get_speeds(), jaylink_jtag_clear_trst(), jaylink_jtag_io(), jaylink_jtag_set_trst(), jaylink_read_raw_config(), jaylink_register(), jaylink_select_interface(), jaylink_set_reset(), jaylink_set_speed(), jaylink_set_target_power(), jaylink_swd_io(), jaylink_swo_get_speeds(), jaylink_swo_read(), jaylink_swo_start(), jaylink_swo_stop(), jaylink_unregister(), jaylink_write_raw_config(), set_socket_timeouts(), transport_close(), transport_open(), transport_read(), transport_start_read(), transport_start_write(), transport_start_write_read(), transport_tcp_close(), transport_tcp_open(), transport_tcp_read(), transport_tcp_start_read(), transport_tcp_start_write(), transport_tcp_start_write_read(), transport_tcp_write(), transport_usb_close(), transport_usb_open(), transport_usb_read(), transport_usb_start_read(), transport_usb_start_write(), transport_usb_start_write_read(), transport_usb_write(), transport_write(), usb_recv(), and usb_send().
◆ read_length
| size_t jaylink_device_handle::read_length |
Number of bytes left for the read operation.
Definition at line 166 of file libjaylink-internal.h.
Referenced by initialize_handle(), transport_tcp_read(), transport_tcp_start_read(), transport_tcp_start_write_read(), transport_usb_read(), transport_usb_start_read(), and transport_usb_start_write_read().
◆ read_pos
| size_t jaylink_device_handle::read_pos |
Current read position in the buffer.
Definition at line 170 of file libjaylink-internal.h.
Referenced by initialize_handle(), transport_tcp_read(), transport_tcp_start_write_read(), transport_usb_read(), and transport_usb_start_write_read().
◆ sock
| int jaylink_device_handle::sock |
Socket descriptor.
This field is used for devices with host interface JAYLINK_HIF_TCP only.
Definition at line 199 of file libjaylink-internal.h.
Referenced by _recv(), _send(), set_socket_timeouts(), and transport_tcp_open().
◆ write_length
| size_t jaylink_device_handle::write_length |
Number of bytes left to be written before the write operation will be performed.
Definition at line 175 of file libjaylink-internal.h.
Referenced by initialize_handle(), transport_tcp_start_write(), transport_tcp_start_write_read(), transport_tcp_write(), transport_usb_start_write(), transport_usb_start_write_read(), and transport_usb_write().
◆ write_pos
| size_t jaylink_device_handle::write_pos |
Current write position in the buffer.
This is equivalent to the number of bytes in the buffer and used for write operations only.
Definition at line 182 of file libjaylink-internal.h.
Referenced by initialize_handle(), transport_tcp_start_write(), transport_tcp_start_write_read(), transport_tcp_write(), transport_usb_start_write(), transport_usb_start_write_read(), and transport_usb_write().
The documentation for this struct was generated from the following file:
