Public Attributes | List of all members
_SbgInterface Struct Reference

#include <sbgInterface.h>

Public Attributes

SbgInterfaceHandle handle
 
char name [SBG_IF_NAME_MAX_SIZE]
 
SbgInterfaceGetDelayFunc pDelayFunc
 
SbgInterfaceFlushFunc pFlushFunc
 
SbgInterfaceReadFunc pReadFunc
 
SbgInterfaceWriteFunc pWriteFunc
 
uint32_t type
 

Detailed Description

Interface definition that stores methods used to communicate on the interface.

The interface class is designed to allow custom user implementations. The type member stores a type identifier allowing the identification of the underlying type, including custom implementations. Standard interfaces provided by this library use types from 1 up to and including SBG_IF_TYPE_LAST_RESERVED. Greater values are intended to identify custom types that are normally specific to the project using this library. The value 0 identifies an unknown interface type, usually indicating that the interface was not correctly initialized.

Definition at line 131 of file sbgInterface.h.

Member Data Documentation

◆ handle

SbgInterfaceHandle _SbgInterface::handle

Internal interface handle used to access the media.

Definition at line 133 of file sbgInterface.h.

◆ name

char _SbgInterface::name[SBG_IF_NAME_MAX_SIZE]

The interface name as passed during the creation

Definition at line 135 of file sbgInterface.h.

◆ pDelayFunc

SbgInterfaceGetDelayFunc _SbgInterface::pDelayFunc

Optional method used to compute an expected delay to transmit/receive X bytes

Definition at line 140 of file sbgInterface.h.

◆ pFlushFunc

SbgInterfaceFlushFunc _SbgInterface::pFlushFunc

Optional method used to make this interface flush all pending data.

Definition at line 139 of file sbgInterface.h.

◆ pReadFunc

SbgInterfaceReadFunc _SbgInterface::pReadFunc

Mandatory method used to read some data to this interface.

Definition at line 138 of file sbgInterface.h.

◆ pWriteFunc

SbgInterfaceWriteFunc _SbgInterface::pWriteFunc

Mandatory method used to write some data to this interface.

Definition at line 137 of file sbgInterface.h.

◆ type

uint32_t _SbgInterface::type

Opaque interface type.

Definition at line 134 of file sbgInterface.h.


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


sbg_driver
Author(s): SBG Systems
autogenerated on Sat Sep 3 2022 02:53:36