com.cinterion.io

Interface ATCommandListener

public interface ATCommandListener

The ATCommandListener interface defines the capabilities for receiving unsolicited AT-Events (e.g. like "RING") and changes of the relevant incoming interface signals (RING, DCD and DSR). When the user wants to receive AT-Events, an implementation class for the ATCommandListener interface must be created first.
The ATEvent method of this class must contain the processing code for the different AT-Events and the RINGChanged, DCDChanged, DSRChanged and CONNChanged methods possible processing code for the signal state changes. Every call of the listener functions is made in a separta thread. So it is possible that a new listener function is called even if a previous called hasn't finished its processing.
After creating an instance of the ATCommandListener class, this class instance has to be passed as a parameter to the ATCommand.addListener method. After that, the callback methods will be called by the runtime system each time the corresponding events (URCs or signal state changes) occur.
Please note that system start URCs like "^SYSSTART", "^SYSSTART ALARM MODE" or "^SYSSTART CHARGE-ONLY MODE" are passed to a Java application after the first AT command has been sent by the ATCommand class after module start. They are passed only to this instance of the ATCommand class which has sent the first AT command obviously only if it has registered an ATCommandListener instance before the command is sent.

Method Summary

Modifier and Type	Method and Description
void	ATEvent(String Event) Callback method for unsolicited AT-Events (URCs).
void	CONNChanged(boolean SignalState) Callback method for change of the state of a data connection.
void	DCDChanged(boolean SignalState) Callback method for change of the serial interface signal DCD (Data Carrier Detect).
void	DSRChanged(boolean SignalState) Callback method for change of the serial interface signal DSR (Data Set Ready).
void	RINGChanged(boolean SignalState) Callback method for change of the serial interface signal RING.

Method Detail

ATEvent

void ATEvent(String Event)

Callback method for unsolicited AT-Events (URCs). The callback method, will be called by the runtime system when AT-Event occurs on the AT-Interface, if an implementation class object is registered as listener for that instance of the ATCommand class. If an AT command generates quite a lot urc in a very short frame, all the urc contents generated, may be divided into several pieces, and each piece will contain max length of 1024 bytes, one piece will be called by one ATEvent call.
While implementing a class for the ATCommandListener interface, the user can place the code for incoming URC processing into this method. Please note that in case of URCs longer than 1024 charaters they might be split by this function being called more than once with the parts of the oversized URC.

Parameters:

Event - The occured AT-Event (URC).

See Also:

ATCommand, ATCommand.addListener(ATCommandListener)

RINGChanged

void RINGChanged(boolean SignalState)

Callback method for change of the serial interface signal RING. The callback method, will be called by the runtime system each time a change of the serial interface signal RING, if an implementation class object is registered as listener for that instance of the ATCommand class.
While implementing a class for the ATCommandListener interface, the user can place the code for RING signal processing into this method. The ATCommand class replaces the connection of the devices AT interpreters to an external device through a serial interface. So this callback will be called each time the physical signal would be changed and is therefore some kind of a virtual RING signal.

Parameters:

SignalState - The new state of the RING signal.

See Also:

ATCommand, ATCommand.addListener(ATCommandListener)

DCDChanged

void DCDChanged(boolean SignalState)

Callback method for change of the serial interface signal DCD (Data Carrier Detect). The callback method, will be called by the runtime system each time a change of the serial interface signal DCD, if an implementation class object is registered as listener for that instance of the ATCommand class.
While implementing a class for the ATCommandListener interface, the user can place the code for DCD signal processing into this method. The ATCommand class replaces the connection of the devices AT interpreters to an external device through a serial interface. So this callback will be called each time the physical signal would be changed and is therefore some kind of a virtual DCD signal.

Parameters:

SignalState - The new state of the DCD signal.

See Also:

ATCommand, ATCommand.addListener(ATCommandListener)

DSRChanged

void DSRChanged(boolean SignalState)

Callback method for change of the serial interface signal DSR (Data Set Ready). The callback method, will be called by the runtime system each time a change of the serial interface signal DSR, if an implementation class object is registered as listener for that instance of the ATCommand class.
While implementing a class for the ATCommandListener interface, the user can place the code for DSR signal processing into this method. The ATCommand class replaces the connection of the devices AT interpreters to an external device through a serial interface. So this callback will be called each time the physical signal would be changed and is therefore some kind of a virtual DSR signal.

Parameters:

SignalState - The new state of the DSR signal.

See Also:

ATCommand, ATCommand.addListener(ATCommandListener)

CONNChanged

void CONNChanged(boolean SignalState)

Callback method for change of the state of a data connection. The callback method, will be called by the runtime system each time a data connection state changes, if an implementation class object is registered as listener for that instance of the ATCommand class. The state of a data connection can change from opened to closed, from data mode to AT command mode and vice versa.
While implementing a class for the ATCommandListener interface, the user can place the code for data connection processing into this method.

Parameters:

SignalState - The new state of a data connection.

See Also:

ATCommand, ATCommand.addListener(ATCommandListener)