_SbgInterface Struct Reference

#include <sbgInterface.h>

Data Fields
SbgInterfaceHandle	handle
uint32_t	type
char	name [SBG_IF_NAME_MAX_SIZE]
SbgInterfaceDestroyFunc	pDestroyFunc
SbgInterfaceWriteFunc	pWriteFunc
SbgInterfaceReadFunc	pReadFunc
SbgInterfaceFlushFunc	pFlushFunc
SbgInterfaceSetSpeed	pSetSpeedFunc
SbgInterfaceGetSpeed	pGetSpeedFunc
SbgInterfaceGetDelayFunc	pDelayFunc

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.

Field Documentation

handle

SbgInterfaceHandle _SbgInterface::handle

Internal interface handle used to access the media.

type

uint32_t _SbgInterface::type

Opaque interface type.

Referenced by sbgInterfaceTypeGet().

name

char _SbgInterface::name[SBG_IF_NAME_MAX_SIZE]

The interface name as passed during the creation

Referenced by sbgInterfaceNameGet().

pDestroyFunc

SbgInterfaceDestroyFunc _SbgInterface::pDestroyFunc

Optional method used to destroy an interface.

pWriteFunc

SbgInterfaceWriteFunc _SbgInterface::pWriteFunc

Optional method used to write some data to this interface.

Referenced by sbgInterfaceWrite().

pReadFunc

SbgInterfaceReadFunc _SbgInterface::pReadFunc

Optional method used to read some data to this interface.

Referenced by sbgInterfaceRead().

pFlushFunc

SbgInterfaceFlushFunc _SbgInterface::pFlushFunc

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

Referenced by sbgInterfaceFlush().

pSetSpeedFunc

SbgInterfaceSetSpeed _SbgInterface::pSetSpeedFunc

Optional method used to set the interface speed in bps.

Referenced by sbgInterfaceSetSpeed().

pGetSpeedFunc

SbgInterfaceGetSpeed _SbgInterface::pGetSpeedFunc

Optional method used to retrieve the interface speed in bps.

Referenced by sbgInterfaceGetSpeed().

pDelayFunc

SbgInterfaceGetDelayFunc _SbgInterface::pDelayFunc

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

Referenced by sbgInterfaceGetDelay().

---

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

• common/interfaces/sbgInterface.h