Sent from web api to client. More...

#include </home/lars/safir/safir-sdk-core/src/safir_dou/gen/cpp/include/Safir/Websocket/Parameters.h>

Inheritance diagram for Safir::Websocket::Parameters:

Collaboration diagram for Safir::Websocket::Parameters:

Public Member Functions
	Parameters ()

Safir::Dob::Typesystem::ObjectPtr	Clone () const override
	Create a copy of the object.

Safir::Dob::Typesystem::TypeId	GetTypeId () const override
	Get the type id of this object.

bool	IsChanged () override
	Check if any member of this object is changed.

void	SetChanged (const bool changed) override
	Recursively set change flags in all members of this object.

Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) override
	Get a reference to a member container from an object.

const Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) const override
	Get a const reference to a member container from an object.

void	WriteToBlob (Safir::Dob::Typesystem::Int64 handle) const override
	Write the object to a blob.

	Parameters (Safir::Dob::Typesystem::Int64 handle)

Public Member Functions inherited from Safir::Dob::Parametrization
	Parametrization ()

Safir::Dob::Typesystem::ObjectPtr	Clone () const override
	Create a copy of the object.

Safir::Dob::Typesystem::TypeId	GetTypeId () const override
	Get the type id of this object.

bool	IsChanged () override
	Check if any member of this object is changed.

void	SetChanged (const bool changed) override
	Recursively set change flags in all members of this object.

Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) override
	Get a reference to a member container from an object.

const Safir::Dob::Typesystem::ContainerBase &	GetMember (const Safir::Dob::Typesystem::MemberIndex member, const Safir::Dob::Typesystem::ArrayIndex index) const override
	Get a const reference to a member container from an object.

void	WriteToBlob (Safir::Dob::Typesystem::Int64 handle) const override
	Write the object to a blob.

	Parametrization (Safir::Dob::Typesystem::Int64 handle)

Public Member Functions inherited from Safir::Dob::Typesystem::Object
	Object ()
	Default constructor.

virtual	~Object ()
	Virtual destructor.

	Object (Safir::Dob::Typesystem::Int64 handle)
	Create an Object from a blob.

Static Public Member Functions
static ParametersPtr	Create ()

static std::wstring	ServerEndpoint ()
	The ip address and port for the websocket server on the format ip_address:port For example if running on loopback interface and port 10000 specify 127.0.0.1:10000 If no ip_address part is specified, the server will use all IPv4 addresses available on the machine.

static Safir::Dob::Typesystem::Si32::Second	PingInterval ()
	Interval at which messges with the ping opcode is sent to clients to keep connection open.

static bool	EnableTypesystemCommands ()
	Should typesystem commands be handled, If False typesystem commands are invalid.

Static Public Member Functions inherited from Safir::Dob::Parametrization
static ParametrizationPtr	Create ()

Static Public Member Functions inherited from Safir::Dob::Typesystem::Object
static Dob::Typesystem::ObjectPtr	Create ()
	Creates a new Object.

Static Public Attributes
static const Safir::Dob::Typesystem::TypeId	ClassTypeId = 9112010565285018424LL
	Type id for Parameters.

Static Public Attributes inherited from Safir::Dob::Parametrization
static const Safir::Dob::Typesystem::TypeId	ClassTypeId = 8075666004421608370LL
	Type id for Parametrization.

Static Public Attributes inherited from Safir::Dob::Typesystem::Object
static const Dob::Typesystem::TypeId	ClassTypeId = 5955188366590963785LL
	The TypeId of the Object class.

Detailed Description

Sent from web api to client.

Constructor & Destructor Documentation

◆ Parameters() [1/2]

Safir::Websocket::Parameters::Parameters ( )

◆ Parameters() [2/2]

Safir::Websocket::Parameters::Parameters ( Safir::Dob::Typesystem::Int64 handle )

explicit

Member Function Documentation

◆ Clone()

Safir::Dob::Typesystem::ObjectPtr Safir::Websocket::Parameters::Clone ( ) const

overridevirtual

Create a copy of the object.

Will create a copy of the object on the heap and return a smart pointer to it. Use std::static_pointer_cast or std::dynamic_pointer_cast to cast it to the pointer type that you're after.

Returns: A smart pointer to the copy of the object.

Reimplemented from Safir::Dob::Typesystem::Object.

◆ Create()

static ParametersPtr Safir::Websocket::Parameters::Create ( )

static

◆ EnableTypesystemCommands()

static bool Safir::Websocket::Parameters::EnableTypesystemCommands ( )

static

Should typesystem commands be handled, If False typesystem commands are invalid.

◆ GetMember() [1/2]

const Safir::Dob::Typesystem::ContainerBase & Safir::Websocket::Parameters::GetMember	(	const Safir::Dob::Typesystem::MemberIndex	member,
		const Safir::Dob::Typesystem::ArrayIndex	index ) const

overridevirtual

Get a const reference to a member container from an object.

Use the methods in Members to get member indices and array sizes for use with this method.

Note: Do not use this method unless you're very sure it is the one you need!

Parameters

member	[in] - The index of the member to get.
index	[in] - The array index of the member to get.

Returns: A const reference to the member container.

Exceptions

IllegalValueException	If the index is not in the range of the array.
SoftwareViolationException	If the element is not an array and the index is not 0.

Reimplemented from Safir::Dob::Typesystem::Object.

◆ GetMember() [2/2]

Safir::Dob::Typesystem::ContainerBase & Safir::Websocket::Parameters::GetMember	(	const Safir::Dob::Typesystem::MemberIndex	member,
		const Safir::Dob::Typesystem::ArrayIndex	index )

overridevirtual

Get a reference to a member container from an object.

Use the methods in Members to get member indices and array sizes for use with this method.

Note: Do not use this method unless you're very sure it is the one you need!

Parameters

member	[in] - The index of the member to get.
index	[in] - The array index of the member to get.

Returns: A reference to the member container.

Exceptions

IllegalValueException	If the index is not in the range of the array.
SoftwareViolationException	If the element is not an array and the index is not 0.

Reimplemented from Safir::Dob::Typesystem::Object.

◆ GetTypeId()

Safir::Dob::Typesystem::TypeId Safir::Websocket::Parameters::GetTypeId ( ) const

overridevirtual

Get the type id of this object.

Gets the type id of the object. Method is virtual to ensure that the right value gets returned for pointers or references.

Note: this method is overridden by all auto-generated classes.

Returns: The TypeId of the object.

Reimplemented from Safir::Dob::Typesystem::Object.

◆ IsChanged()

bool Safir::Websocket::Parameters::IsChanged ( )

overridevirtual

Check if any member of this object is changed.

This method will recursively check if any member of the object has its change flag set.

Note: this method is overridden by all auto-generated classes.

Returns: True if any member has changed.

Reimplemented from Safir::Dob::Typesystem::Object.

◆ PingInterval()

static Safir::Dob::Typesystem::Si32::Second Safir::Websocket::Parameters::PingInterval ( )

static

Interval at which messges with the ping opcode is sent to clients to keep connection open.

Negative value means never send ping. Disable ping can be usefull if the client does not support websocket Ping/Pong messages. In that case it is better to disable ping by setting this value to -1 and instead fallback to let the client send Safir defined Ping messges to the server at appropriate interval, see documentation.

◆ ServerEndpoint()

static std::wstring Safir::Websocket::Parameters::ServerEndpoint ( )

static

The ip address and port for the websocket server on the format ip_address:port For example if running on loopback interface and port 10000 specify 127.0.0.1:10000 If no ip_address part is specified, the server will use all IPv4 addresses available on the machine.

I.e if you specify :10000 then the websocket server is available on port 10000 on all network adapters on the machine.

◆ SetChanged()

void Safir::Websocket::Parameters::SetChanged ( const bool changed )

overridevirtual

Recursively set change flags in all members of this object.

Note: this method is overridden by all auto-generated classes.

Parameters

changed [in] - The value to set the change flags to

Reimplemented from Safir::Dob::Typesystem::Object.

◆ WriteToBlob()

void Safir::Websocket::Parameters::WriteToBlob ( Safir::Dob::Typesystem::Int64 handle ) const

overridevirtual

Write the object to a blob.

Parameters

handle [in] - Handle to a blobWriter that is the destination of the serialized object.

Reimplemented from Safir::Dob::Typesystem::Object.

Member Data Documentation

◆ ClassTypeId

const Safir::Dob::Typesystem::TypeId Safir::Websocket::Parameters::ClassTypeId = 9112010565285018424LL

static

Type id for Parameters.

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Parameters() [1/2]

◆ Parameters() [2/2]

Member Function Documentation

◆ Clone()

◆ Create()

◆ EnableTypesystemCommands()

◆ GetMember() [1/2]

◆ GetMember() [2/2]

◆ GetTypeId()

◆ IsChanged()

◆ PingInterval()

◆ ServerEndpoint()

◆ SetChanged()

◆ WriteToBlob()

Member Data Documentation

◆ ClassTypeId