|
C12Adapter Opensource C++ Interface
|
Modem callback channel is MChannelModem that has Auto Answer enabled by default. More...
Public Member Functions | |
| MChannelModemCallback () | |
| Create a callback modem channel with initial parameters. | |
| virtual | ~MChannelModemCallback () |
| Destroy channel. More... | |
 Public Member Functions inherited from MChannelModem | |
| MChannelModem () | |
| Create a channel with initial parameters. | |
| virtual | ~MChannelModem () |
| Destroy channel modem. More... | |
| virtual void | Connect () |
| Connect to the meter, where connection means hook off, dialing phone number, checking for modem responses. More... | |
| virtual void | WaitForNextIncomingConnection (bool reinitialize=true) |
| When GetAutoAnswer true, wait for the incoming connection without disconnecting the channel. More... | |
| virtual void | Disconnect () |
| Disconnect channel. More... | |
| virtual bool | IsConnected () const |
| Returns true if channel is connected and false otherwise. More... | |
| virtual void | CheckIfConnected () |
| Throw an appropriate exception if the channel is not connected. More... | |
| const MByteString & | GetModemResponse () const |
| Full modem response after the successful connection, or after any successful control command. More... | |
| virtual void | CancelCommunication (bool callDisconnect=false) |
| Request canceling of the communication. More... | |
| void | HookOn () |
| Auxiliary function "hook on". More... | |
| void | SendCommand (const MByteString &command) |
| Send command to the modem and complete it with line completion char (see m_lineCompletionChar). More... | |
| MByteString | ReceiveResponse () |
| Receive response string from the modem after the command was sent. More... | |
| MModemResponse | ReceiveKnownResponse (int timeout) |
| Get the response which is enlisted in MModemResponse type definition. More... | |
| void | SendCommandCheckOK (const MByteString &command) |
| Send command and completion char then check response for OK. More... | |
| const MByteString & | GetAutoAnswerString () const |
| void | SetAutoAnswerString (const MByteString &autoAnswerString) |
| const MByteString & | GetInitString () const |
| void | SetInitString (const MByteString &initString) |
| const MByteString & | GetDialString () const |
| void | SetDialString (const MByteString &dialString) |
| const MByteString & | GetPhoneNumber () const |
| void | SetPhoneNumber (const MByteString &phoneNumber) |
| unsigned | GetDialTimeout () const |
| void | SetDialTimeout (unsigned timeout) |
| unsigned | GetCommandTimeout () const |
| void | SetCommandTimeout (unsigned timeout) |
| bool | GetMatchConnectBaud () const |
| void | SetMatchConnectBaud (bool doMatch) |
| Public Member Functions inherited from MChannelSerialPort | |
| MChannelSerialPort () | |
| Construct serial port channel. | |
| virtual | ~MChannelSerialPort () |
| Destructor. | |
| virtual void | FlushOutputBuffer (unsigned numberOfCharsInBuffer=UINT_MAX) |
| Ensure that the characters from the output buffer are sent. More... | |
| void | SetParameters (unsigned baud, int dataBits, char parity, int stopBits) |
| SetParameters is a convenience function for setting the properties baud rate, number of data bits, parity, and number of stop bits in a single call. | |
| bool | GetDCD () const |
| The current state of the DCD signal of the port. More... | |
| virtual MStdString | GetMediaIdentification () const |
| Return a string that will identify the media through which this channel is talking to. More... | |
| const MStdString & | GetPortName () const |
| void | SetPortName (const MStdString &portName) |
| unsigned | GetBaud () const |
| void | SetBaud (unsigned baud) |
| char | GetParity () const |
| void | SetParity (char p) |
| int | GetStopBits () const |
| void | SetStopBits (int stopBits) |
| int | GetDataBits () const |
| void | SetDataBits (int dataBits) |
| bool | GetCtsFlow () const |
| void | SetCtsFlow (bool isCtsFlow) |
| bool | GetDsrFlow () const |
| void | SetDsrFlow (bool isDsrFlow) |
| bool | GetDsrSensitivity () const |
| void | SetDsrSensitivity (bool isDsrSens) |
| char | GetDtrControl () const |
| void | SetDtrControl (char dtrControl) |
| char | GetRtsControl () const |
| void | SetRtsControl (char rtsControl) |
| MSerialPort & | GetPort () |
| const MSerialPort & | GetPort () const |
| Public Member Functions inherited from MChannel | |
| virtual MChannel * | CreateClone () const |
| Virtual copy constructor, creates the channel, which is a clone of current. More... | |
| virtual | ~MChannel () |
| The destructor is public, and virtual. More... | |
| void | WriteBytes (const MByteString &buffer) |
| Writes the data to the channel, and returns when the last byte has been sent by the software. More... | |
| void | WriteByte (Muint8 b) |
| Writes a byte to the channel, and returns when it has been sent. More... | |
| void | WriteBuffer (const char *buf, unsigned len) |
| Writes the data buffer to the channel, and returns when the last character has been sent by the software (but hardware might still need to do some work). More... | |
| Muint8 | ReadByte () |
| Read a single byte from the channel. More... | |
| void | ReadBuffer (char *buf, unsigned numberToRead) |
| Read an exact number of characters from the channel. More... | |
| void | Unread (const MVariant &byteOrBytes) |
| Return the given byte or bytes to the stream buffer so they get read at the next read operation. More... | |
| void | UnreadBuffer (const char *buff, unsigned size) |
| Return the given bytes to the stream buffer so they get read at the next read operation. More... | |
| MByteString | ReadBytes (unsigned numberToRead) |
| Read bytes directly from the communication channel. More... | |
| MByteString | ReadBytesUntil (const MByteString &terminatingString) |
| Read bytes from the channel until a specified sequence is read. More... | |
| MByteString | ReadBytesUntilAnyByte (const char *finisher, unsigned finisherSize, unsigned headerSize, unsigned footerSize) |
| Read bytes from the channel until a specified sequence is read. More... | |
| MByteString | ReadAllBytes () |
| Read an arbitrary number of characters from the channel, as much as available. More... | |
| void | ClearInputBuffer () |
| Immediately discards all the pending characters from the channel. More... | |
| void | ClearInputUntilSilence (unsigned milliseconds) |
| Keep reading and ignoring input until there is silence. More... | |
| void | CheckIfConnectedConst () const |
| Throw an appropriate exception if the channel is not connected, constant version. More... | |
| unsigned | GetCountBytesSent () const |
| Number of bytes sent through the channel since its creation or since the last ResetCounts(). More... | |
| unsigned | GetCountBytesReceived () const |
| The number of bytes received through the channel since creation or since the last ResetCounts(). More... | |
| void | ResetCounts () |
| Reset channel statistical data, so the counters become zeros. More... | |
| virtual void | WriteToMonitor (const MStdString &message) |
| Synchronously write a message to the monitor, if it is connected. More... | |
| void | EnterUninterruptibleCommunication (bool notify=true) |
| Enter a communication sequence that shall not be be interrupted with CancelCommunication call. More... | |
| void | LeaveUninterruptibleCommunication (bool notify=true) |
| Leave a communication sequence that shall not be be interrupted with CancelCommunication call. More... | |
| void | CheckIfOperationIsCancelled () |
| Check if the user has requested the termination of the communication, and whether the cancel operation lock is zero. More... | |
| void | Sleep (unsigned milliseconds) |
| Channel version of Sleep, a delay function that is aware of cancel communication event. More... | |
| unsigned | ReadWithTimeout (char *buf, unsigned size, unsigned timeout) |
| Read up to size bytes into buffer using the given timeout. More... | |
| bool | GetAutoAnswer () const |
| void | SetAutoAnswer (bool isAutoAnswer) |
| unsigned | GetAutoAnswerTimeout () const |
| void | SetAutoAnswerTimeout (unsigned timeout) |
| void | SetMonitor (MMonitor::Pointer monitor) |
| MMonitor::Pointer | GetMonitor () const |
| SHOW_INTERNAL bool | GetEcho () const |
| void | SetEcho (bool echo) |
| bool | GetSendEchoBytesToMonitor () const |
| void | SetSendEchoBytesToMonitor (bool doSend) |
| unsigned | GetIntercharacterTimeout () const |
| void | SetIntercharacterTimeout (unsigned timeout) |
| unsigned | GetReadTimeout () const |
| void | SetReadTimeout (unsigned timeout) |
| unsigned | GetWriteTimeout () const |
| void | SetWriteTimeout (unsigned timeout) |
| Public Member Functions inherited from MCOMObject | |
| virtual | ~MCOMObject () |
| Object destructor. | |
| virtual MStdStringVector | GetAllPropertyNames () const |
| Return the list of publicly available properties in MCOM syntax. More... | |
| virtual MStdStringVector | GetAllPersistentPropertyNames () const |
| Return the list of publicly available persistent properties in MCOM syntax. More... | |
| MStdString | GetPersistentPropertyValues (bool onlyNondefaults=false, bool excludeSecurityRelated=false) const |
| Get the string with the list of persistent property names and their values. More... | |
| void | SetPersistentPropertyValues (const MStdString &values) |
| Set the persistent properties for the object using the string with the following format: More... | |
| void | SetPropertyValues (const MDictionary &values) |
| Set the properties for the object using the property list object. More... | |
| void | WritePropertiesToMonitor () |
| Write all non-default values of protocol properties into monitor. More... | |
| MStdString | DoGetPersistentPropertyValues0 () const |
| Get the string with the whole list of persistent property names and their values. More... | |
| MStdString | DoGetPersistentPropertyValues1 (bool onlyNondefaults) const |
| Get the string with the list of persistent property names and their values. More... | |
| Public Member Functions inherited from MObject | |
| virtual | ~MObject () |
| Object destructor. | |
| virtual const MClass * | GetClass () const =0 |
| Get the final class of the object. More... | |
| virtual unsigned | GetEmbeddedSizeof () const |
| For embedded object types, return the size of the class. More... | |
| bool | IsEmbeddedObject () const |
| Tell if the object is of embedded kind. More... | |
| SHOW_INTERNAL MVariant | Call (const MStdString &name, const MVariant ¶ms) |
| Call the object service with parameters, given as variant. More... | |
| MVariant | Call0 (const MStdString &name) |
| Call the object service with no parameters. More... | |
| MVariant | Call1 (const MStdString &name, const MVariant &p1) |
| Call the object service with one parameter. More... | |
| MVariant | Call2 (const MStdString &name, const MVariant &p1, const MVariant &p2) |
| Call the object service with two parameter. More... | |
| MVariant | Call3 (const MStdString &name, const MVariant &p1, const MVariant &p2, const MVariant &p3) |
| Call the object service with three parameter. More... | |
| MVariant | Call4 (const MStdString &name, const MVariant &p1, const MVariant &p2, const MVariant &p3, const MVariant &p4) |
| Call the object service with four parameter. More... | |
| MVariant | Call5 (const MStdString &name, const MVariant &p1, const MVariant &p2, const MVariant &p3, const MVariant &p4, const MVariant &p5) |
| Call the object service with five parameter. More... | |
| MVariant | Call6 (const MStdString &name, const MVariant &p1, const MVariant &p2, const MVariant &p3, const MVariant &p4, const MVariant &p5, const MVariant &p6) |
| Call the object service with six parameter. More... | |
| virtual MVariant | CallV (const MStdString &name, const MVariant::VariantVector ¶ms) |
| Call the object service with parameters, given as variant vector. More... | |
| virtual bool | IsPropertyPresent (const MStdString &name) const |
| Tell if the property with the given name exists. | |
| virtual bool | IsServicePresent (const MStdString &name) const |
| Tell if the service with the given name exists. | |
| virtual MVariant | GetProperty (const MStdString &name) const |
| Get the property value using name of the property. More... | |
| virtual void | SetProperty (const MStdString &name, const MVariant &value) |
| Set the property using name of the property, and value. More... | |
| virtual void | SetPersistentPropertiesToDefault () |
| Set the persistent properties of the object to their default values. More... | |
| virtual MVariant | GetPersistentPropertyDefaultValue (const MStdString &name) const |
| Get the default value of persistent property with the name given. More... | |
| virtual void | SetPersistentPropertyToDefault (const MStdString &name) |
| Set the persistent property with the name given to default value. More... | |
| virtual const char * | GetType () const |
| Get the name of the type for the object (could be the same as class name). | |
| virtual void | SetType (const MStdString &) |
| Intentionally, it will set the name of the type for the object, but the service will not allow setting the name to anything other than the current name. More... | |
| virtual void | Validate () |
| Validate internal structures of the object. More... | |
Additional Inherited Members | |
| Public Types inherited from MChannelModem | |
| enum | MModemResponse { MODEM_RESPONSE_UNKNOWN, MODEM_RESPONSE_OK, MODEM_RESPONSE_CONNECT, MODEM_RESPONSE_RING, MODEM_RESPONSE_NO_CARRIER, MODEM_RESPONSE_ERROR, MODEM_RESPONSE_TIMEOUT, MODEM_RESPONSE_NO_DIALTONE, MODEM_RESPONSE_BUSY, MODEM_RESPONSE_NO_ANSWER } |
| Possible modem response codes. More... | |
| Public Types inherited from MChannel | |
| enum | { CANCEL_COMMUNICATION_CHECK_OPTIMUM_INTERVAL = 1000 } |
| Static Public Member Functions inherited from MChannelSerialPort | |
| static MStdStringVector | GetAvailablePortNames (bool addExtraInfo=false) |
| Return a collection of serial port names available at this computer. More... | |
| static MStdString | GetPortType (const MStdString &portName) |
| Get type based on the port name. More... | |
| Static Public Member Functions inherited from MObject | |
| static const MClass * | GetStaticClass () |
| Get the declared class of this particular object. More... | |
| static bool | IsClassPresent (const MStdString &name) |
| Tells if the given class name is available. More... | |
| Static Public Attributes inherited from MObject | |
| static const MClass | s_class |
| Class of MObject. | |
| Protected Member Functions inherited from MChannel | |
| MChannel () | |
| Construct the channel object from parent class. More... | |
| Protected Member Functions inherited from MCOMObject | |
| MCOMObject () | |
| Object constructor, protected as the class is abstract. | |
| Protected Member Functions inherited from MObject | |
| MObject () | |
| Object constructor, protected as the class is abstract. | |
| void | DoSetPersistentPropertiesToDefault (const MClass *staticClass) |
| Set the persistent properties to their default values for one object provided the class for that object. More... | |
Modem callback channel is MChannelModem that has Auto Answer enabled by default.
This class is a convenient way of establishing modem callback stations (servers). Different from MChannelModem, this class sets persistent property MChannelModem::SetAutoAnswer to true by default. This property can be set to false by applications, in which case the behavior of this class will be indistinguishable from its parent.
|
virtual |
Destroy channel.
If channel is connected then it will be disconnected within this call.
1.8.11 
