MChannelSocket implements the channel interface for an IP socket, either TCP or UDP. More...

Inheritance diagram for MChannelSocketBase:

[legend]

Public Member Functions
virtual	~MChannelSocketBase ()
	Destructor.

virtual void	Connect ()=0
	Partly implemented connect method, overridden by children. More...

virtual bool	IsConnected () const
	Returns the current state of the socket channel.

virtual void	Disconnect ()
	Partly implemented disconnect method, overridden by children. More...

const MStreamSocketBase &	GetSocketConst () const
	Get the constant socket object that is used by this channel.

MStdString	GetActualLocalAddress () const
	Get the actual address of the local socket as it is known by Sockets. More...

unsigned	GetActualLocalPort () const
	Get the actual port number of the local socket as it is known by Sockets. More...

MStdString	GetActualPeerAddress () const
	Get the actual address of the peer socket as it is known by Sockets. More...

unsigned	GetActualPeerPort () const
	Get the actual port number of the peer socket as it is known by Sockets. More...

virtual void	FlushOutputBuffer (unsigned numberOfCharsInBuffer=UINT_MAX)
	Ensure that the characters from the output buffer are sent. More...

virtual MStdString	GetMediaIdentification () const
	Return a string that identifies the media through which this channel is talking. More...


unsigned	GetAutoAnswerPort () const

void	SetAutoAnswerPort (unsigned port)


const MStdString &	GetAutoAnswerAddress () const

void	SetAutoAnswerAddress (const MStdString &addr)


MStreamSocketBase &	GetSocket ()

virtual void	SetSocket (MStreamSocketBase &)=0


const MStdString &	GetPeerAddress () const

void	SetPeerAddress (const MStdString &addr)


unsigned	GetPeerPort () const

void	SetPeerPort (unsigned port)

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...

virtual void	WaitForNextIncomingConnection (bool reinitialize=true)
	When GetAutoAnswer true, wait for the incoming connection without disconnecting the channel. 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...

virtual void	CheckIfConnected ()
	Throw an appropriate exception if the channel is not connected. 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...

virtual void	CancelCommunication (bool callDisconnect=false)
	Request canceling of the communication. 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 &params)
	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 &params)
	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...

Protected Member Functions
	MChannelSocketBase ()
	Construct the abstract socket channel.

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...

Additional Inherited Members
Public Types inherited from MChannel
enum	{ CANCEL_COMMUNICATION_CHECK_OPTIMUM_INTERVAL = 1000 }

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.

Detailed Description

MChannelSocket implements the channel interface for an IP socket, either TCP or UDP.

MChannelSocket implements an IP socket behavior and inherits properties from its abstract parent class, Channel.

Member Function Documentation

virtual void MChannelSocketBase::Connect ( )

pure virtual

Partly implemented connect method, overridden by children.

This method handles RAS connection, when RAS is enabled.

Reimplemented from MChannel.

Implemented in MChannelSocketUdp, and MChannelSocket.

virtual void MChannelSocketBase::Disconnect ( )

virtual

Partly implemented disconnect method, overridden by children.

This method handles RAS disconnect, when RAS is enabled.

Implements MChannel.

Reimplemented in MChannelSocket.

virtual void MChannelSocketBase::FlushOutputBuffer ( unsigned numberOfCharsInBuffer = UINT_MAX )

virtual

Ensure that the characters from the output buffer are sent.

The parameter, if specified, should match the number of characters written into the serial port right before FlushOutputBuffer is called. If the parameter is missing, the biggest possible number of characters will be ensured to go away. For the case of socket it is known that this number has no relevance.

Precondition: The channel is open, otherwise the operation fails with the exception.

Implements MChannel.

MStdString MChannelSocketBase::GetActualLocalAddress ( ) const

Get the actual address of the local socket as it is known by Sockets.

The address of the local socket that was used during communication. It is available only during an active connection (after the completion of a successful Connect() and before the termination of the connection due to a Disconnect() or an error). If the property is queried without an active connection, an error will be raised. Use IsConnected() to determine if this property is available.

Precondition: The connection should be open, otherwise a socket related exception is thrown.

Since: MeteringSDK Version 2.1.27. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Returns: string

unsigned MChannelSocketBase::GetActualLocalPort ( ) const

Get the actual port number of the local socket as it is known by Sockets.

The port number of the local socket used for the outbound communication. The Actual Local Port number is a random number assigned by Sockets. It is available only during an active connection (after the completion of a successful Connect() and before the termination of the connection due to a Disconnect() or an error). If the property is queried without an active connection, an error will be raised. Use IsConnected() to determine if this property is available.

Precondition: The connection should be open, otherwise a socket related exception is thrown.

Since: MeteringSDK Version 2.1.27. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Returns: int

MStdString MChannelSocketBase::GetActualPeerAddress ( ) const

Get the actual address of the peer socket as it is known by Sockets.

The address of the peer socket as known to the sockets library. It is available only during an active connection (after the completion of a successful Connect() and before the termination of the connection due to a Disconnect() or an error). If the property is queried without an active connection, an error will be raised. Use IsConnected() to determine if this property is available.

Precondition: The connection should be open, otherwise a socket related exception is thrown.

Since: MeteringSDK Version 2.1.27. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Returns: string

unsigned MChannelSocketBase::GetActualPeerPort ( ) const

Get the actual port number of the peer socket as it is known by Sockets.

The port number of the peer socket as known to the sockets library. It is available only during an active connection (after the completion of a successful Connect() and before the termination of the connection due to a Disconnect() or an error). If the property is queried without an active connection, an error will be raised. Use IsConnected() to determine if this property is available.

The Actual Peer Port number will be the same as GetPeerPort unless the server has multiple clients, in which case it will wait on one port, and accept connections on another.

Precondition: The connection should be open, otherwise a socket related exception is thrown.

Since: MeteringSDK Version 2.1.27. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Returns: int

const MStdString& MChannelSocketBase::GetAutoAnswerAddress ( ) const

inline

Address to bind to when Auto Answer mode is enabled (waiting for the incoming connection).

When this is an empty string, all active network interfaces are bound for listening. Otherwise, this has to be a valid IP address or host name of an interface on which to listen. SetAutoAnswer must be true for the channel to be ready for an inbound connection and for this property to have any effect.

Since: MeteringSDK Version 6.2.0.4315. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Default value:: "" (empty string)

unsigned MChannelSocketBase::GetAutoAnswerPort ( ) const

inline

Port to listen to when in Auto Answer mode is enabled (waiting for the incoming connection).

SetAutoAnswer must be true for the channel to be ready for an inbound connection and for this property to have any effect.

Since: MeteringSDK Version 4.0.15. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Default value:: 1153

Possible values: 0 .. 0xFFFF

virtual MStdString MChannelSocketBase::GetMediaIdentification ( ) const

virtual

Return a string that identifies the media through which this channel is talking.

For socket based channels, it will return a host name, SOCKET string, and peer name and port.

Implements MChannel.

const MStdString& MChannelSocketBase::GetPeerAddress ( ) const

inline

The address of the peer socket, either an IP address as string, or a DNS name.

It is the socket to which this one connects, either a direct IP address, or the host name.

Since: MeteringSDK Version 2.1.27. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Default value:: "" (empty string)

unsigned MChannelSocketBase::GetPeerPort ( ) const

inline

Port number of the peer socket to which socket object connects.

The default value 1153 is suited for C12.22.

Since: MeteringSDK Version 2.1.27. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Default value:: 1153

Possible values: 0x0 .. 0xFFFF

MStreamSocketBase& MChannelSocketBase::GetSocket ( )

inline

Socket object that is used by this channel.

Setting socket object has a feature: what actually happens, this channel's socket is swapped with the given socket. The channel type accepted depends on the actual final class: ChannelSocket accepts only StreamSocket, while ChannelSocketUdp accepts only StreamSocketUdp.

void MChannelSocketBase::SetAutoAnswerAddress ( const MStdString & addr )

inline

Address to bind to when Auto Answer mode is enabled (waiting for the incoming connection).

When this is an empty string, all active network interfaces are bound for listening. Otherwise, this has to be a valid IP address or host name of an interface on which to listen. SetAutoAnswer must be true for the channel to be ready for an inbound connection and for this property to have any effect.

Since: MeteringSDK Version 6.2.0.4315. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Default value:: "" (empty string)

void MChannelSocketBase::SetAutoAnswerPort ( unsigned port )

Port to listen to when in Auto Answer mode is enabled (waiting for the incoming connection).

SetAutoAnswer must be true for the channel to be ready for an inbound connection and for this property to have any effect.

Since: MeteringSDK Version 4.0.15. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Default value:: 1153

Possible values: 0 .. 0xFFFF

void MChannelSocketBase::SetPeerAddress ( const MStdString & addr )

inline

The address of the peer socket, either an IP address as string, or a DNS name.

It is the socket to which this one connects, either a direct IP address, or the host name.

Since: MeteringSDK Version 2.1.27. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Default value:: "" (empty string)

void MChannelSocketBase::SetPeerPort ( unsigned port )

Port number of the peer socket to which socket object connects.

The default value 1153 is suited for C12.22.

Since: MeteringSDK Version 2.1.27. In MeteringSDK Version 6.2.0.4233, support was added for UDP (User Datagram Protocol) messages. To facilitate this change, a new abstract class was created, MChannelSocketBase, which became the parent for all other socket classes. Prior to Version 6.2.0.4233, this property was in the MChannelSocket class.

Default value:: 1153

Possible values: 0x0 .. 0xFFFF

virtual void MChannelSocketBase::SetSocket ( MStreamSocketBase & )

pure virtual

Socket object that is used by this channel.

Setting socket object has a feature: what actually happens, this channel's socket is swapped with the given socket. The channel type accepted depends on the actual final class: ChannelSocket accepts only StreamSocket, while ChannelSocketUdp accepts only StreamSocketUdp.

Implemented in MChannelSocketUdp, and MChannelSocket.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation