hamlib_port Struct Reference

Port definition. More...

#include <port.h>

Collaboration diagram for hamlib_port:

Data Structures
union	[union].type
struct	[struct].post_write_date
union	[union].parm

Data Fields
union	type
int	fd
void *	handle
int	write_delay
int	post_write_delay
struct	post_write_date
int	timeout
short	retry
short	flushx
char	pathname [HAMLIB_FILPATHLEN]
union	parm
int	client_port
RIG *	rig
int	asyncio
int	fd_sync_write
int	fd_sync_read
int	fd_sync_error_write
int	fd_sync_error_read
short	timeout_retry

Detailed Description

Port definition.

Of course, looks like OO painstakingly programmed in C, sigh.

Warning

DO NOT CHANGE THIS STRUCTURE AT ALL UNTIL 5.0. Right now it is static inside the rig structure. 5.0 will change it to a pointer which can then be added to. At that point only add to the end of the structure.

Field Documentation

asyncio

int hamlib_port::asyncio

enable asynchronous data handling if true – async collides with python keyword so _async is used

client_port

int hamlib_port::client_port

client socket port for tcp connection

fd

int hamlib_port::fd

File descriptor

fd_sync_error_read

int hamlib_port::fd_sync_error_read

file descriptor for reading synchronous data error codes

fd_sync_error_write

int hamlib_port::fd_sync_error_write

file descriptor for writing synchronous data error codes

fd_sync_read

int hamlib_port::fd_sync_read

file descriptor for reading synchronous data

fd_sync_write

int hamlib_port::fd_sync_write

file descriptor for writing synchronous data

flushx

short hamlib_port::flushx

If true flush is done with read instead of TCFLUSH - MicroHam

handle

void* hamlib_port::handle

handle for USB

parm

union hamlib_port::[union].parm hamlib_port::parm

Port parameter union

Examples

/tests/testrig.c.

pathname

char hamlib_port::pathname[HAMLIB_FILPATHLEN]

Port pathname

post_write_date

struct hamlib_port::[struct].post_write_date hamlib_port::post_write_date

hamlib internal use

post_write_delay

int hamlib_port::post_write_delay

Delay between each commands send out, in mS

retry

short hamlib_port::retry

Maximum number of retries, 0 to disable

rig

RIG* hamlib_port::rig

our parent RIG device

Examples

/tests/testrig.c.

timeout

int hamlib_port::timeout

Timeout, in mS

timeout_retry

short hamlib_port::timeout_retry

number of retries to make in case of read timeout errors, some serial interfaces may require this, 0 to disable

type

union hamlib_port::[union].type hamlib_port::type

Type of port in use.

Examples

/tests/testrig.c.

write_delay

int hamlib_port::write_delay

Delay between each byte sent out, in mS

---

The documentation for this struct was generated from the following file:

• port.h