SerialPortBase

abstract

class SerialPortBase {

SPHandle _handle;

alias Config = SPConfig;

this(string exmode);

this(string port, string mode);

this(string port, uint baudRate);

this(string port, uint baudRate, string mode);

this(string port, Config conf);

void close();

string name();

inout(SPHandle) handle();

void reopen(string np, Config cfg);

void reopen(string np);

void reopen(Config cfg);

void reopen();

string toString();

typeof(this) set(T val);

typeof(this) set(string val);

bool closed();

const(Config) config();

void config(Config c);

Parity parity [@property getter];

uint baudRate [@property getter];

DataBits dataBits [@property getter];

StopBits stopBits [@property getter];

Parity parity [@property setter];

uint baudRate [@property setter];

DataBits dataBits [@property setter];

StopBits stopBits [@property setter];

static string[] listAvailable();

void[] m_read(void[] buf);

size_t m_write(const(void[]) arr);

void setup(Config conf);

void m_tcgetattr(termios* t);

void m_tcsetattr(int v, const(termios*) t);

version(Posix)
version(usetermios2)

void m_ioctl(int v, termios2* t);

void posixSetup(Config conf);

void openPort();

void setCC(ubyte[2] val);

ubyte[2] getCC();

void initialConfig(Config conf);

void setUintBaudRate(uint br);

uint getUintBaudRate();

version(Windows)

void winSetup();

version(Windows)

void updTimeouts();

version(Windows)

void setTimeouts(DWORD rit, DWORD rttm, DWORD rttc, DWORD wttm, DWORD wttc);

}

Constructors

this this(string exmode): Construct SerialPort using extend mode string.
this this(string port, string mode): Construct SerialPort using port name and mode string.
this this(string port, uint baudRate)
this this(string port, uint baudRate, string mode)
this this(string port, Config conf)

Destructor

~this ~this(): Undocumented in source.

Members

Aliases

Config alias Config = SPConfig

Functions

close void close(): Close handle
closed bool closed()
config const(Config) config(): Get config
config void config(Config c): Set config
getCC ubyte[2] getCC(): Get termios.c_ccVMIN and .c_ccVMAX
getUintBaudRate uint getUintBaudRate(): Undocumented in source. Be warned that the author may not have intended to support it.
handle inout(SPHandle) handle()
initialConfig void initialConfig(Config conf): Undocumented in source. Be warned that the author may not have intended to support it.
m_ioctl void m_ioctl(int v, termios2* t): Undocumented in source. Be warned that the author may not have intended to support it.
m_read void[] m_read(void[] buf): Undocumented in source. Be warned that the author may not have intended to support it.
m_tcgetattr void m_tcgetattr(termios* t): Undocumented in source. Be warned that the author may not have intended to support it.
m_tcsetattr void m_tcsetattr(int v, const(termios*) t): Undocumented in source. Be warned that the author may not have intended to support it.
m_write size_t m_write(const(void[]) arr): Undocumented in source. Be warned that the author may not have intended to support it.
name string name(): Port name
openPort void openPort(): Undocumented in source. Be warned that the author may not have intended to support it.
posixSetup void posixSetup(Config conf): Undocumented in source. Be warned that the author may not have intended to support it.
reopen void reopen(string np, Config cfg)
reopen void reopen(string np)
reopen void reopen(Config cfg)
reopen void reopen()
set typeof(this) set(T val): Set config value
set typeof(this) set(string val): Set config mode string
setCC void setCC(ubyte[2] val): Set termios.c_ccVMIN and .c_ccVMAX
setTimeouts void setTimeouts(DWORD rit, DWORD rttm, DWORD rttc, DWORD wttm, DWORD wttc): Undocumented in source. Be warned that the author may not have intended to support it.
setUintBaudRate void setUintBaudRate(uint br): Undocumented in source. Be warned that the author may not have intended to support it.
setup void setup(Config conf): open handler, set new config
toString string toString(): Returns extend mode string (example: "/dev/ttyUSB0:38400:8N1")
updTimeouts void updTimeouts(): Undocumented in source. Be warned that the author may not have intended to support it.
winSetup void winSetup(): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

baudRate uint baudRate [@property getter]
baudRate uint baudRate [@property setter]
dataBits DataBits dataBits [@property getter]
dataBits DataBits dataBits [@property setter]
parity Parity parity [@property getter]
parity Parity parity [@property setter]
stopBits StopBits stopBits [@property getter]
stopBits StopBits stopBits [@property setter]

Static functions

listAvailable string[] listAvailable(): List of available serial ports in system

Variables

_handle SPHandle _handle;: Undocumented in source.
port string port;

Meta

Source

See Implementation

serialport base classes