DSAM port interface. More...

import"DsamPort.idl";

Classes
struct	Info
	Port info. More...

struct	InfoChangedEvent
	Event that is send when the port info has changed. More...

struct	Settings
	Port settings. More...

struct	SettingsChangedEvent
	Event that is send whenthe port settings have changed. More...

Public Types
enum	DeviceInterfaceType { DEV_IFTYPE_AUTO , DEV_IFTYPE_DTE , DEV_IFTYPE_DCE }
	Derial device interface type. More...

enum	Parity { PARITY_NONE , PARITY_ODD , PARITY_EVEN }
	Parity mode. More...

enum	FlowControl { FLOW_CTRL_NONE , FLOW_CTRL_HARDWARE , FLOW_CTRL_SOFTWARE }
	Flow control type. More...

enum	State { STATE_AVAILABLE , STATE_OCCUPIED , STATE_BUSY }
	Port state. More...

Public Member Functions
Info	getInfo ()
	Get current port info. More...

Settings	getSettings ()
	Get current port settings. More...

int	setSettings (in Settings settings)
	Set port settings. More...

int	getTtyUsbNumber ()
	Get the number of the ttyUSB device. More...

void	setState (in State state)
	Set the state of the port. More...

Public Attributes
constant int	SUCCESS = 0
	Success code.

constant int	SETTINGS_INVALID = 1
	Error codes.

constant int	SSH_DPA_PORT_INVALID = 2

constant int	SSH_DPA_PORT_IN_USE = 3

Detailed Description

DSAM port interface.

Member Enumeration Documentation

◆ DeviceInterfaceType

enum dsam::DsamPort::DeviceInterfaceType

Derial device interface type.

Enumerator
DEV_IFTYPE_AUTO	auto detect
DEV_IFTYPE_DTE	DTE (Data Terminal Equipment) device detected.
DEV_IFTYPE_DCE	DCE (Data Communications Equipment) device detected.

◆ FlowControl

enum dsam::DsamPort::FlowControl

Flow control type.

Enumerator
FLOW_CTRL_NONE	No flow control.
FLOW_CTRL_HARDWARE	Hardware flow control.
FLOW_CTRL_SOFTWARE	Software flow control.

◆ Parity

enum dsam::DsamPort::Parity

Parity mode.

Enumerator
PARITY_NONE	No parity (implies 8 data bits)
PARITY_ODD	Odd parity (implies 7 data bits)
PARITY_EVEN	Even parity (implies 7 data bits)

◆ State

enum dsam::DsamPort::State

Port state.

Enumerator
STATE_AVAILABLE	no clients connected to port
STATE_OCCUPIED	at least one client connected, more clients allowed
STATE_BUSY	no more clients allowed

Member Function Documentation

◆ getInfo()

Info dsam::DsamPort::getInfo ( )

Get current port info.

Returns: Port info

◆ getSettings()

Settings dsam::DsamPort::getSettings ( )

Get current port settings.

Returns: Port settings.

◆ getTtyUsbNumber()

int dsam::DsamPort::getTtyUsbNumber ( )

Get the number of the ttyUSB device.

NOTE: This function is only used internally and is not available via JSON-RPC.

Returns: ttyUSB device number

◆ setSettings()

int dsam::DsamPort::setSettings ( in Settings settings )

Set port settings.

Parameters

settings Port settings

Returns: SUCCESS if no error occured or one of the defined error codes

◆ setState()

void dsam::DsamPort::setState ( in State state )

Set the state of the port.