#include <modemclient.h>

Inherits client, and modemutil.

Public Member Functions
	modemclient ()

virtual	~modemclient ()

void	setParameters (dictionary< const char , const char > *cd)

void	setConnectScript (const char *connectscript)

void	setCustomAtCommands (const char *customatcommands)

void	setPhoneNumber (const char *phonenumber)

void	setDisconnectScript (const char *disconnectscript)

const char *	getConnectScript ()

const char *	getCustomAtCommands ()

const char *	getPhoneNumber ()

const char *	getDisconnectScript ()

int32_t	connect ()

bool	close ()

Public Member Functions inherited from client
	client ()

virtual	~client ()

void	setTimeoutSeconds (int32_t timeoutsec)

void	setTimeoutMicroseconds (int32_t timeoutusec)

void	setRetryWait (uint32_t retrywait)

void	setTries (uint32_t tries)

void	setVerboseConnectError (const char *error)

int32_t	getTimeoutSeconds ()

int32_t	getTimeoutMicroseconds ()

uint32_t	getRetryWait ()

uint32_t	getTries ()

const char *	getVerboseConnectError ()

Public Member Functions inherited from filedescriptor
	filedescriptor ()

virtual	~filedescriptor ()

int32_t	getFileDescriptor ()

void	setFileDescriptor (int32_t filedesc)

bool	setIsStream (bool isstream)

bool	getIsStream ()

int32_t	duplicate ()

bool	duplicate (int32_t newfd)

void	setSocketLayer (socketlayer *layer)

socketlayer *	getSocketLayer ()

virtual bool	supportsBlockingAndNonBlockingModes ()

virtual bool	setNonBlockingMode (bool usenonblockingmode)

virtual bool	getNonBlockingMode ()

virtual off64_t	getPosition ()

virtual off64_t	setPositionRelativeToBeginning (off64_t offset)

virtual off64_t	setPositionRelativeToCurrent (off64_t offset)

virtual off64_t	setPositionRelativeToEnd (off64_t offset)

ssize_t	write (uint16_t number)

ssize_t	write (uint32_t number)

ssize_t	write (uint64_t number)

ssize_t	write (int16_t number)

ssize_t	write (int32_t number)

ssize_t	write (int64_t number)

ssize_t	write (float number)

ssize_t	write (double number)

ssize_t	write (byte_t character)

ssize_t	write (char character)

ssize_t	write (wchar_t character)

ssize_t	writeUcs2 (ucs2_t character)

ssize_t	write (bool value)

ssize_t	write (const byte_t *string)

ssize_t	write (const char *string)

ssize_t	write (const wchar_t *string)

ssize_t	writeUcs2 (const ucs2_t *string)

ssize_t	write (const byte_t *string, size_t size)

ssize_t	write (const char *string, size_t length)

ssize_t	write (const wchar_t *string, size_t length)

ssize_t	writeUcs2 (const ucs2_t *string, size_t length)

ssize_t	write (const void *buffer, size_t size)

ssize_t	write (uint16_t number, int32_t sec, int32_t usec)

ssize_t	write (uint32_t number, int32_t sec, int32_t usec)

ssize_t	write (uint64_t number, int32_t sec, int32_t usec)

ssize_t	write (int16_t number, int32_t sec, int32_t usec)

ssize_t	write (int32_t number, int32_t sec, int32_t usec)

ssize_t	write (int64_t number, int32_t sec, int32_t usec)

ssize_t	write (float number, int32_t sec, int32_t usec)

ssize_t	write (double number, int32_t sec, int32_t usec)

ssize_t	write (byte_t character, int32_t sec, int32_t usec)

ssize_t	write (char character, int32_t sec, int32_t usec)

ssize_t	write (wchar_t character, int32_t sec, int32_t usec)

ssize_t	writeUcs2 (ucs2_t character, int32_t sec, int32_t usec)

ssize_t	write (bool value, int32_t sec, int32_t usec)

ssize_t	write (const byte_t *string, int32_t sec, int32_t usec)

ssize_t	write (const char *string, int32_t sec, int32_t usec)

ssize_t	write (const wchar_t *string, int32_t sec, int32_t usec)

ssize_t	writeUcs2 (const ucs2_t *string, int32_t sec, int32_t usec)

ssize_t	write (const byte_t *string, size_t size, int32_t sec, int32_t usec)

ssize_t	write (const char *string, size_t length, int32_t sec, int32_t usec)

ssize_t	write (const wchar_t *string, size_t length, int32_t sec, int32_t usec)

ssize_t	writeUcs2 (const ucs2_t *string, size_t length, int32_t sec, int32_t usec)

ssize_t	write (const void *buffer, size_t size, int32_t sec, int32_t usec)

ssize_t	read (uint16_t *buffer)

ssize_t	read (uint32_t *buffer)

ssize_t	read (uint64_t *buffer)

ssize_t	read (int16_t *buffer)

ssize_t	read (int32_t *buffer)

ssize_t	read (int64_t *buffer)

ssize_t	read (float *buffer)

ssize_t	read (double *buffer)

ssize_t	read (byte_t *buffer)

ssize_t	read (char *buffer)

ssize_t	read (wchar_t *buffer)

ssize_t	readUcs2 (ucs2_t *buffer)

ssize_t	read (bool *buffer)

ssize_t	read (byte_t *buffer, size_t size)

ssize_t	read (char *buffer, size_t length)

ssize_t	read (wchar_t *buffer, size_t length)

ssize_t	readUcs2 (ucs2_t *buffer, size_t length)

ssize_t	read (void *buf, size_t size)

ssize_t	read (char *buffer, const char terminator)

ssize_t	read (char *buffer, const char terminator, size_t maxbytes)

ssize_t	read (uint16_t *buffer, int32_t sec, int32_t usec)

ssize_t	read (uint32_t *buffer, int32_t sec, int32_t usec)

ssize_t	read (uint64_t *buffer, int32_t sec, int32_t usec)

ssize_t	read (int16_t *buffer, int32_t sec, int32_t usec)

ssize_t	read (int32_t *buffer, int32_t sec, int32_t usec)

ssize_t	read (int64_t *buffer, int32_t sec, int32_t usec)

ssize_t	read (float *buffer, int32_t sec, int32_t usec)

ssize_t	read (double *buffer, int32_t sec, int32_t usec)

ssize_t	read (byte_t *buffer, int32_t sec, int32_t usec)

ssize_t	read (char *buffer, int32_t sec, int32_t usec)

ssize_t	read (wchar_t *buffer, int32_t sec, int32_t usec)

ssize_t	readUcs2 (ucs2_t *buffer, int32_t sec, int32_t usec)

ssize_t	read (bool *buffer, int32_t sec, int32_t usec)

ssize_t	read (byte_t *buffer, size_t size, int32_t sec, int32_t usec)

ssize_t	read (char *buffer, size_t length, int32_t sec, int32_t usec)

ssize_t	read (wchar_t *buffer, size_t length, int32_t sec, int32_t usec)

ssize_t	readUcs2 (ucs2_t *buffer, size_t length, int32_t sec, int32_t usec)

ssize_t	read (void *buf, size_t size, int32_t sec, int32_t usec)

ssize_t	read (char *buffer, const char terminator, int32_t sec, int32_t usec)

ssize_t	read (char *buffer, const char terminator, size_t maxbytes, int32_t sec, int32_t usec)

ssize_t	read (char *buffer, const char terminator, size_t maxbytes, char escapechar, int32_t sec, int32_t usec)

int32_t	waitForNonBlockingRead (int32_t sec, int32_t usec)

int32_t	waitForNonBlockingWrite (int32_t sec, int32_t usec)

void	setRetryInterruptedReads (bool retry)

bool	getRetryInterruptedReads ()

void	setRetryInterruptedWrites (bool retry)

bool	getRetryInterruptedWrites ()

void	setRetryInterruptedWaits (bool retry)

bool	getRetryInterruptedWaits ()

void	setRetryInterruptedFcntl (bool retry)

bool	getRetryInterruptedFcntl ()

void	setRetryInterruptedIoctl (bool retry)

bool	getRetryInterruptedIoctl ()

void	setAllowShortReads (bool allow)

bool	getAllowShortReads ()

void	setAllowShortWrites (bool allow)

bool	getAllowShortWrites ()

virtual bool	passFileDescriptor (int32_t fd)

virtual bool	passFileDescriptor (int32_t fd, int32_t sec, int32_t usec)

virtual bool	receiveFileDescriptor (int32_t *fd)

virtual bool	receiveFileDescriptor (int32_t *fd, int32_t sec, int32_t usec)

virtual bool	passSocket (int32_t sock)

virtual bool	passSocket (int32_t sock, int32_t sec, int32_t usec)

virtual bool	receiveSocket (int32_t *sock)

virtual bool	receiveSocket (int32_t *sock, int32_t sec, int32_t usec)

void	setTranslateByteOrder (bool translate)

bool	getTranslateByteOrder ()

virtual int32_t	fCntl (int32_t command, long arg)

virtual int32_t	ioCtl (int32_t command, void *arg)

bool	setNaglesAlgorithmEnabled (bool enabled)

bool	getNaglesAlgorithmEnabled ()

bool	setSocketWriteBufferSize (int32_t size)

bool	getSocketWriteBufferSize (int32_t *size)

bool	setSocketReadBufferSize (int32_t size)

bool	getSocketReadBufferSize (int32_t *size)

bool	disableIPv4 ()

bool	enableIPv4 ()

const char *	getType ()

char *	getPeerAddress ()

bool	setWriteBufferSize (size_t size)

size_t	getWriteBufferSize ()

bool	flushWriteBuffer (int32_t sec, int32_t usec)

bool	setReadBufferSize (size_t size)

size_t	getReadBufferSize ()

void	setMmapBufferingEnabled (bool enabled)

bool	getMmapBufferingEnabled ()

bool	isCurrentBlockMmapBuffered ()

off64_t	getCurrentBlockOffset ()

bool	setCloseOnExec (bool close)

bool	getCloseOnExec ()

Public Member Functions inherited from input
	input ()

virtual	~input ()

ssize_t	read (char *buffer, const char terminator)

ssize_t	read (char *buffer, const char terminator, size_t maxbytes)

ssize_t	read (char *buffer, const char terminator, int32_t sec, int32_t usec)

ssize_t	read (char *buffer, const char terminator, size_t maxbytes, int32_t sec, int32_t usec)

ssize_t	read (char *buffer, const char terminator, size_t maxbytes, char escapechar, int32_t sec, int32_t usec)

Public Member Functions inherited from object
virtual	~object ()

Public Member Functions inherited from output
	output ()

virtual	~output ()

virtual ssize_t	printf (const char *format,...)

virtual ssize_t	printf (const char format, va_list argp)

virtual ssize_t	printf (const wchar_t *format,...)

virtual ssize_t	printf (const wchar_t format, va_list argp)

virtual ssize_t	printfUcs2 (const ucs2_t *format,...)

virtual ssize_t	printfUcs2 (const ucs2_t format, va_list argp)

void	safePrint (byte_t c)

void	safePrint (const byte_t *str)

void	safePrint (const byte_t *str, int32_t length)

void	safePrint (char c)

void	safePrint (const char *str)

void	safePrint (const char *str, int32_t length)

void	printBits (byte_t value)

void	printBits (uint16_t value)

void	printBits (uint32_t value)

void	printBits (uint64_t value)

void	printBits (char value)

void	printBits (int16_t value)

void	printBits (int32_t value)

void	printBits (int64_t value)

void	printBits (const byte_t *bits, uint64_t size)

void	printHex (const byte_t *data, uint64_t size)

void	printHex (const byte_t *data, uint64_t size, uint16_t indent)

Public Member Functions inherited from modemutil
	modemutil ()

virtual	~modemutil ()

void	setDevice (const char *device)

void	setBaud (const char *baud)

const char *	getDevice ()

const char *	getBaud ()

Additional Inherited Members
Static Public Member Functions inherited from filedescriptor
static bool	supportsPassAndReceiveFileDescriptor ()

static bool	supportsPassAndReceiveSocket ()

static bool	createPipe (filedescriptor readfd, filedescriptor writefd)

static uint16_t	convertHostToNet (uint16_t value)

static uint32_t	convertHostToNet (uint32_t value)

static uint64_t	convertHostToNet (uint64_t value)

static uint16_t	convertNetToHost (uint16_t value)

static uint32_t	convertNetToHost (uint32_t value)

static uint64_t	convertNetToHost (uint64_t value)

static uint16_t	convertHostToLittleEndian (uint16_t value)

static uint32_t	convertHostToLittleEndian (uint32_t value)

static uint64_t	convertHostToLittleEndian (uint64_t value)

static uint16_t	convertLittleEndianToHost (uint16_t value)

static uint32_t	convertLittleEndianToHost (uint32_t value)

static uint64_t	convertLittleEndianToHost (uint64_t value)

Detailed Description

The modemclient implements methods for connecting to and communicating with a remote host using a modem.

Constructor & Destructor Documentation

◆ modemclient()

modemclient::modemclient ( )

Creates an instance of the modemclient class.

◆ ~modemclient()

virtual modemclient::~modemclient ( )

virtual

Deletes this instance of the modemclient class.

Member Function Documentation

◆ close()

bool modemclient::close ( )

virtual

Hangs up the modem and closes the device.

Returns true on success and false on failure.

Reimplemented from filedescriptor.

◆ connect()

int32_t modemclient::connect ( )

virtual

Dials the modem and attempt to establish a connection. If the connection fails, it will retry, for a total of "tries" attempts, waiting "retrywait" seconds between each attempt.

Setting "tries" to 0 will cause it to try to connect indefinitely. Setting "retrywait" to 0 will cause it to try to connect over and over as fast as possible (not recommended).

Each attempt to connect will wait "timeoutsec" seconds and "timeoutusec" microseconds for the connect to succeed. Specifying -1 for either parameter will cause the attempt to wait until the underlying protocol times out which may be up to 2 minutes.

Returns RESULT_SUCCESS on success and RESULT_ERROR on failure.

Reimplemented from client.

◆ getConnectScript()

const char * modemclient::getConnectScript ( )

Returns the connect script (usually a set of AT commands) that connect() will send to the modem during a connect attempt.

◆ getCustomAtCommands()

const char * modemclient::getCustomAtCommands ( )

Returns the set of custom AT commands that will replace the substitution variable in the connect script, if the connect script contains this variable.

◆ getDisconnectScript()

const char * modemclient::getDisconnectScript ( )

Returns the disconnect script (usually a set of AT commands) that close() will send to the modem during close.

◆ getPhoneNumber()

const char * modemclient::getPhoneNumber ( )

Returns the phone number that will replace the substitution variable in the connect script, if the connect script contains this variable.

◆ setConnectScript()

void modemclient::setConnectScript ( const char * connectscript )

Sets the connect script (usually a set of AT commands) that connect() will send to the modem during a connect attempt. The connect script may contain and substitution variables, which will be replaced with whatever values are set by setCustomAtCommands() and setPhoneNumber().

◆ setCustomAtCommands()

void modemclient::setCustomAtCommands ( const char * customatcommands )

Sets a set of custom AT commands that will replace the substitution variable in the connect script, if the connect script contains this variable.

◆ setDisconnectScript()

void modemclient::setDisconnectScript ( const char * disconnectscript )

Sets the disconnect script (usually a set of AT commands) that close() will send to the modem during close.

◆ setParameters()

void modemclient::setParameters ( dictionary< const char *, const char * > * cd )

virtual

Queries "cd" for "device", "baud", "connectscript", "phonenumber", "disconnectscript", "retrywait" and "tries" and configures this instance to use the results when connect() is called.

Reimplemented from client.

◆ setPhoneNumber()

void modemclient::setPhoneNumber ( const char * phonenumber )

Sets a phone number that will replace the substitution variable in the connect script, if the connect script contains this variable.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ modemclient()

◆ ~modemclient()

Member Function Documentation

◆ close()

◆ connect()

◆ getConnectScript()

◆ getCustomAtCommands()

◆ getDisconnectScript()

◆ getPhoneNumber()

◆ setConnectScript()

◆ setCustomAtCommands()

◆ setDisconnectScript()

◆ setParameters()

◆ setPhoneNumber()