C12Adapter Opensource C++ Interface
MSockOptEnum Class Reference

Enumerations and constants for socket options. More...

Inheritance diagram for MSockOptEnum:

Public Types

enum  Type {
  SolSocket = SOL_SOCKET,
  SoAcceptconn = SO_ACCEPTCONN,
  SoBroadcast = SO_BROADCAST,
  SoDebug = SO_DEBUG,
  SoDontroute = SO_DONTROUTE,
  SoError = SO_ERROR,
  SoKeepalive = SO_KEEPALIVE,
  SoLinger = SO_LINGER,
  SoRcvbuf = SO_RCVBUF,
  SoReuseaddr = SO_REUSEADDR,
  SoRcvtimeo = SO_RCVTIMEO,
  SoSndbuf = SO_SNDBUF,
  SoSndtimeo = SO_SNDTIMEO,
  IpprotoIpv6 = IPPROTO_IPV6,
  Ipv6Tclass = IPV6_TCLASS,
  Ipv6V6only = IPV6_V6ONLY
}
 Actual enumeration type. More...
 

Public Member Functions

 MSockOptEnum ()
 Constructor that creates an unassigned enumeration type.
 
 MSockOptEnum (Type &type)
 Constructor that initializes the object with the given value of type.
 
 MSockOptEnum (const MSockOptEnum &type)
 Constructor that copies an enumeration type from another MSockOptEnum value.
 
MSockOptEnumoperator= (const MSockOptEnum &other)
 Assignment operator that initializes an enumeration type with the value of another given type.
 
bool operator== (const MSockOptEnum &other) const
 Checks for equal values of the type and another type.
 
bool operator!= (const MSockOptEnum &other) const
 Checks for inequality of the type and another type.
 
- Public Member Functions inherited from MObject
virtual ~MObject ()
 Object destructor.
 
virtual const MClassGetClass () 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 MStdStringVector GetAllPropertyNames () const
 Return the list of publicly available properties, persistent or not. More...
 
virtual MStdStringVector GetAllPersistentPropertyNames () const
 Return the list of persistent properties. 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

- Static Public Member Functions inherited from MObject
static const MClassGetStaticClass ()
 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 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...
 

Detailed Description

Enumerations and constants for socket options.

These are used as parameters of MStreamSocketBase::SetSockOpt, MStreamSocketBase::GetSockOpt, and MStreamSocketBase::GetSockOptBytes.

C++ interface can use the system defined enumerations directly.

Member Enumeration Documentation

Actual enumeration type.

Enumerator
SolSocket 

Socket level value, first parameter of MStreamSocketBase::GetSockOpt and MStreamSocketBase::SetSockOpt.

SoAcceptconn 

Get listening status of the socket, get only, integer 0 or -1.

SoBroadcast 

Configure for sending a broadcast, integer 0 or -1.

SoDebug 

Debug mode, integer 0 or -1.

SoDontroute 

Do not route, integer 0 or -1.

SoError 

Return socket error and clear error, get only, integer.

SoKeepalive 

Configure for keep alive packets, integer 0 or -1.

SoLinger 

Linger on closing the socket until all the data is sent, integer 0 or -1.

SoRcvbuf 

Integer size of receive buffer.

SoReuseaddr 

If the socket is bound to an already bound address, reuse the address, 0 or -1.

SoRcvtimeo 

recv timeout in milliseconds for blocking mode

SoSndbuf 

Integer size of send buffer.

SoSndtimeo 

send timeout in milliseconds for blocking mode

IpprotoIpv6 

IPv6 level value, first parameter of GetSockOpt/SetSockOpt.

Ipv6Tclass 

IPv6 traffic class value, integer property.

Ipv6V6only 

Whether the socket is restricted to IPv6 communications only, integer 0 or -1.