Kanzi Connect 3.9.10
kanzi::connect::StreamSetEncoderParameterMethod Class Reference

#include <stream_messages.hpp>

Inheritance diagram for kanzi::connect::StreamSetEncoderParameterMethod:
kanzi::connect::MessagePackage

Public Member Functions

kanzi::string getParameterNameArgument () const
 
kanzi::string getParameterValueArgument () const
 
kanzi::string getStreamIdArgument () const
 
void setParameterNameArgument (const kanzi::string &parameterName)
 
void setParameterValueArgument (const kanzi::string &parameterValue)
 
void setStreamIdArgument (const kanzi::string &streamId)
 
 StreamSetEncoderParameterMethod ()
 
- Public Member Functions inherited from kanzi::connect::MessagePackage
bool addBinaryAttribute (int key, const string &value)
 Add a binary string value to an attribute.
 
bool addBinaryAttributeEx (int key, const unsigned char *blob, size_t size)
 Add a binary data t to an attribute.
 
bool addBoolAttribute (int key, bool value)
 Add a boolean value to an attribute.
 
bool addDoubleAttribute (int key, double value)
 Add a double value to an attribute.
 
bool addFloatAttribute (int key, float value)
 Add a floating point value to an attribute.
 
bool addInt64Attribute (int key, int64_t value)
 Add 64bit integer value to an attribute.
 
bool addIntAttribute (int key, int value)
 Add a integer value to an attribute.
 
bool addPackageAttribute (int key, const MessagePackage &value)
 Add a child message package to an attribute.
 
bool addStringAttribute (int key, const string &value)
 Add a string value to an attribute.
 
bool addUInt64Attribute (int key, uint64_t value)
 Add 64-bit integer value to an attribute.
 
bool addUIntAttribute (int key, unsigned int value)
 Add a integer value to an attribute.
 
unsigned int byteSize () const
 Get binary size for the message.
 
virtual void clear ()
 Purge the contents of the package.
 
void eraseAttribute (int key)
 Erase attribute array i.e.
 
string getAttributeKeyString (int key) const
 Get attribute key string for an attribute.
 
AttributeType getAttributeType (int key) const
 Get the type of an attribute.
 
size_t getAttributeValuesCount (int key) const
 Get the size of values array for an .
 
string getBinaryAttribute (int key, size_t index) const
 Get the binary string value of an attribute.
 
bool getBoolAttribute (int key, size_t index) const
 Get the boolean value of an attribute.
 
int getClientIdentifier () const
 Get client identifier.
 
double getDoubleAttribute (int key, size_t index) const
 Get the double value of an attribute.
 
float getFloatAttribute (int key, size_t index) const
 Get the floating point value of an attribute.
 
uint32_t getHandle () const
 
int64_t getInt64Attribute (int key, size_t index) const
 Get the integer value of an attribute.
 
int getIntAttribute (int key, size_t index) const
 Get the integer value of an attribute.
 
string getInterfaceIdentifier () const
 Get interface identifier.
 
string getInvokeName () const
 Get invoke name.
 
MessageType getMessageType () const
 Get message type.
 
MessagePackage getPackageAttribute (int key, size_t index) const
 Get the child message package of an attribute.
 
bool getPackageAttributeTo (int key, size_t index, MessagePackage *to) const
 Get the child message package of an attribute.
 
int getSessionIdentifier () const
 Get session identifier.
 
string getSourceClientAddress () const
 Retrieve configured client address.
 
int getSourceClientIdentifier () const
 Retrieve source client identifier.
 
string getSourceClientName () const
 Retrieve configure client name.
 
string getSourceClientProtocol () const
 Retrieve configured client protocol.
 
string getStringAttribute (int key, size_t index) const
 Get the string value of an attribute.
 
virtual string getType () const
 Get identity of this message.
 
uint64_t getUInt64Attribute (int key, size_t index) const
 Get the 64-bit unsigned integer value of an attribute.
 
unsigned int getUIntAttribute (int key, size_t index) const
 Get the unsigned integer value of an attribute.
 
virtual bool initialize (const string &buffer, bool isBinary)
 
 MessagePackage ()
 
 MessagePackage (const MessagePackage &package)
 
 MessagePackage (MessagePackage &&package)
 
MessagePackageoperator= (const MessagePackage &package)
 
virtual string serializeAsString () const
 Serialize message container to a string.
 
bool setAttributeKeyString (int key, const string &keyString)
 Set attribute key string for an attribute.
 
bool setClientIdentifier (int identifier)
 Set client identifier for the message package.
 
bool setHandle (uint32_t handle)
 
bool setInterfaceIdentifier (const string &identifier)
 Set interface identifier for the message package.
 
bool setInvokeName (const string &invokeName)
 Set invoke name for the message package.
 
bool setMessageType (MessageType type)
 Set message type.
 
bool setSessionIdentifier (int identifier)
 Set session identifier for the message package.
 
bool setSourceClientAddress (const string &address)
 Sets a client address.
 
bool setSourceClientIdentifier (int identifier)
 Sets a client identifier.
 
bool setSourceClientName (const string &name)
 Sets a client name.
 
bool setSourceClientProtocol (const string &protocol)
 Sets a client protocol.
 
virtual bool setType (const string &type)
 Set identity for this message.
 
virtual ~MessagePackage ()
 

Static Public Member Functions

static kanzi::string Type ()
 

Additional Inherited Members

- Public Types inherited from kanzi::connect::MessagePackage
enum  AttributeType {
  ATTRIBUTE_VALUE_TYPE_UNKNOWN = 0 , ATTRIBUTE_VALUE_TYPE_INTEGER = 1 , ATTRIBUTE_VALUE_TYPE_FLOAT = 2 , ATTRIBUTE_VALUE_TYPE_BOOL = 3 ,
  ATTRIBUTE_VALUE_TYPE_STRING = 4 , ATTRIBUTE_VALUE_TYPE_BINARY = 5 , ATTRIBUTE_VALUE_TYPE_PACKAGE = 6 , ATTRIBUTE_VALUE_TYPE_INTEGER64 = 7 ,
  ATTRIBUTE_VALUE_TYPE_DOUBLE = 8 , ATTRIBUTE_VALUE_TYPE_UNSIGNED_INTEGER = 9 , ATTRIBUTE_VALUE_TYPE_UNSIGNED_INTEGER64 = 10 , ATTRIBUTE_VALUE_TYPE_VOID = 11
}
 
enum  CongestionControl { CONGESTION_CONTROL_NONE = 0 , CONGESTION_CONTROL_KEEP_LAST = 1 , CONGESTION_CONTROL_ARRAY_ATTRIBUTES = 2 }
 
enum  FixedAttributeKeys {
  ATTRIBUTE_KEY_UNKNOWN = 0 , ATTRIBUTE_KEY_NAME = 1 , ATTRIBUTE_KEY_EXPECTED_RETURNVALUE_TYPE = 2 , ATTRIBUTE_KEY_RETURNVALUE = 3 ,
  ATTRIBUTE_KEY_ARGUMENT_COUNT = 4 , ATTRIBUTE_KEY_CLIENTID = 5 , ATTRIBUTE_KEY_SESSIONID = 6 , ATTRIBUTE_KEY_INTERFACEID = 7 ,
  ATTRIBUTE_KEY_TO_JSON = 8 , ATTRIBUTE_KEY_MESSAGETYPE = 9 , ATTRIBUTE_KEY_VERSION = 10 , ATTRIBUTE_KEY_WRAPPED_MESSAGE = 11 ,
  ATTRIBUTE_KEY_P2P_CLIENT_ID = 12 , ATTRIBUTE_KEY_REMOTESERVICE_CLIENT_PROTOCOL = 13 , ATTRIBUTE_KEY_REMOTESERVICE_CLIENT_ADDRESS = 14 , ATTRIBUTE_KEY_REMOTESERVICE_CLIENT_NAME = 15 ,
  ATTRIBUTE_KEY_REMOTESERVICE_CLIENT_IDENTIFIER = 16 , ATTRIBUTE_KEY_P2P_SERVER_CLIENT_ID = 17 , ATTRIBUTE_KEY_CONGESTION_CONTROL = 18 , ATTRIBUTE_KEY_INVOKE_NAME = 19 ,
  ATTRIBUTE_KEY_ARGUMENT_1 = 20 , ATTRIBUTE_KEY_ARGUMENT_101 = 120 , ATTRIBUTE_KEY_LAST_RESERVED = 127 , ATTRIBUTE_KEY_RPC_CALL_HANDLE = -128 ,
  ATTRIBUTE_KEY_RPC_STATUS = -129 , ATTRIBUTE_KEY_TYPE_DETAILS = -130 , ARRIBUTE_KEYS_BEGIN_EXTENDED_RANGE = 227
}
 
enum  MessageType {
  MESSAGETYPE_UNSPECIFIED = 0 , MESSAGETYPE_METHOD = 1 , MESSAGETYPE_ROUTED_METHOD = 2 , MESSAGETYPE_EVENT = 3 ,
  MESSAGETYPE_ROUTED_EVENT = 4 , MESSAGETYPE_METHOD_RETURN = 5 , MESSAGETYPE_ROUTED_METHOD_RETURN = 6 , MESSAGETYPE_INVALID_ARGUMENTS_RESPONSE = 7 ,
  MESSAGETYPE_ATTRIBUTE_IS_SETTER = 32 , MESSAGETYPE_ATTRIBUTE_IS_GETTER = 33 , MESSAGETYPE_ATTRIBUTE_IS_NOTIFY = 34
}
 
enum  SerializationFormat { SerializationFormatBinary = 1 , SerializationFormatJson , SerializationFormatCompressedBinary }
 
- Public Attributes inherited from kanzi::connect::MessagePackage
unique_ptr< MessagePackageData > m_data
 

Constructor & Destructor Documentation

◆ StreamSetEncoderParameterMethod()

kanzi::connect::StreamSetEncoderParameterMethod::StreamSetEncoderParameterMethod ( )
inline

Member Function Documentation

◆ getParameterNameArgument()

kanzi::string kanzi::connect::StreamSetEncoderParameterMethod::getParameterNameArgument ( ) const
inline

◆ getParameterValueArgument()

kanzi::string kanzi::connect::StreamSetEncoderParameterMethod::getParameterValueArgument ( ) const
inline

◆ getStreamIdArgument()

kanzi::string kanzi::connect::StreamSetEncoderParameterMethod::getStreamIdArgument ( ) const
inline

◆ setParameterNameArgument()

void kanzi::connect::StreamSetEncoderParameterMethod::setParameterNameArgument ( const kanzi::string & parameterName)
inline

◆ setParameterValueArgument()

void kanzi::connect::StreamSetEncoderParameterMethod::setParameterValueArgument ( const kanzi::string & parameterValue)
inline

◆ setStreamIdArgument()

void kanzi::connect::StreamSetEncoderParameterMethod::setStreamIdArgument ( const kanzi::string & streamId)
inline

◆ Type()

static kanzi::string kanzi::connect::StreamSetEncoderParameterMethod::Type ( )
inlinestatic

The documentation for this class was generated from the following file: