Arp::Base::Rsc::Commons::Services::RscServerContext Class Reference

This class provides RSC session infos and the actual service invocation infos. More...

#include <RscServerContext.hpp>

Inheritance diagram for Arp::Base::Rsc::Commons::Services::RscServerContext:

Public Member Functions
	RscServerContext (Impl &impl, RscContext::Impl &implBase)
	Constructs a RscServerContext instance. More...
	RscServerContext (const RscServerContext &arg)=delete
	RscServerContext (RscServerContext &&arg) noexcept
	The default move constructor. More...
RscServerContext &	operator= (const RscServerContext &arg)=delete
RscServerContext &	operator= (RscServerContext &&arg) noexcept
	The default move-assignment operator. More...
	~RscServerContext (void)
	The default destructor.
bool	IsSecure (void) const
	Determines if security is applied for this service call from within the client. More...
bool	HasSecurity (void) const
	Determines if the RSC session (connection) requires security. More...
SecurityToken	GetSecurityToken (void) const
	Gets the security token of this service call. More...
RscHandle	GetMethodHandle (void) const
	Gets the method handle of this service call. More...
const char *	GetServiceName (void) const
	Gets the service name of the service. More...
const char *	GetServiceProviderName (void) const
	Gets the service provider name of the service. More...
void	AbortRequest (RscError errorCode, const char *errorMessage=nullptr)
	Aborts a RSC request More...
void	AbortConnection (RscError errorCode, const char *errorMessage=nullptr)
	Aborts/closes a RSC connection. More...
void	AbortInvocation (RscError errorCode, const char *errorMessage=nullptr)
	Aborts a RSC service invocation More...
Impl &	GetImpl (void)
	For internal use only. More...
const Impl &	GetImpl (void) const
Public Member Functions inherited from Arp::Base::Rsc::Commons::Services::RscContext
	RscContext (Impl &impl)
	Constructs a RscContext instance. More...
	RscContext (const RscContext &arg)=delete
	RscContext (RscContext &&arg) noexcept
	The default move constructor. More...
RscContext &	operator= (const RscContext &arg)=delete
RscContext &	operator= (RscContext &&arg) noexcept
	The default move-assignment operator. More...
	~RscContext (void)
	The default destructor.
RscReader &	GetReader (void)
	Gets the RSC reader. More...
RscWriter &	GetWriter (void)
	Gets the RSC writer. More...
Impl &	GetImpl (void)
	For internal use only. More...
const Impl &	GetImpl (void) const
Public Member Functions inherited from Arp::Base::Rsc::Commons::Services::SerializationContext
	SerializationContext (SerializationKind kind)
	Constructs a serialization context with the supplied serialization kind. More...
	SerializationContext (const SerializationContext &arg)
	The default copy constructor. More...
	SerializationContext (SerializationContext &&arg) noexcept
	The default move constructor. More...
SerializationContext &	operator= (const SerializationContext &arg)
	The default copy-assignment operator. More...
SerializationContext &	operator= (SerializationContext &&arg) noexcept
	The default move-assignment operator. More...
virtual	~SerializationContext (void)
	The default destructor.
SerializationKind	GetSerializationKind (void) const
	Gets the serialization kind of this context. More...

Detailed Description

This class provides RSC session infos and the actual service invocation infos.

This class is not intended for direct use, but required by RscGenerator to implement services.

Constructor & Destructor Documentation

RscServerContext() [1/2]

Arp::Base::Rsc::Commons::Services::RscServerContext::RscServerContext	(	Impl &	impl,
		RscContext::Impl &	implBase
	)

Constructs a RscServerContext instance.

Parameters

impl	The impl instance.
implBase	The impl base instance.

For internal use only.

RscServerContext() [2/2]

Arp::Base::Rsc::Commons::Services::RscServerContext::RscServerContext ( RscServerContext &&  arg )

defaultnoexcept

The default move constructor.

Parameters

arg	The argument to move.

Member Function Documentation

AbortConnection()

void Arp::Base::Rsc::Commons::Services::RscServerContext::AbortConnection	(	RscError	errorCode,
		const char *	errorMessage = nullptr
	)

Aborts/closes a RSC connection.

Parameters

errorCode	The RSC error code.
errorMessage	The error message.

For internal use only.

AbortInvocation()

void Arp::Base::Rsc::Commons::Services::RscServerContext::AbortInvocation	(	RscError	errorCode,
		const char *	errorMessage = nullptr
	)

Aborts a RSC service invocation

Parameters

errorCode	The RSC error code.
errorMessage	The error message.

For internal use only.

AbortRequest()

void Arp::Base::Rsc::Commons::Services::RscServerContext::AbortRequest	(	RscError	errorCode,
		const char *	errorMessage = nullptr
	)

Aborts a RSC request

Parameters

errorCode	The RSC error code.
errorMessage	The error message.

For internal use only.

GetImpl()

const RscServerContext::Impl & Arp::Base::Rsc::Commons::Services::RscServerContext::GetImpl

(

void

)

For internal use only.

Returns

The impl instance.

GetMethodHandle()

RscHandle Arp::Base::Rsc::Commons::Services::RscServerContext::GetMethodHandle

(

void

)

const

Gets the method handle of this service call.

Returns

The method handle of this service call.

The method handle determines the operation of a service, which shall be invoked.

GetSecurityToken()

SecurityToken Arp::Base::Rsc::Commons::Services::RscServerContext::GetSecurityToken

(

void

)

const

Gets the security token of this service call.

Returns

The security token of this service call.

GetServiceName()

const char * Arp::Base::Rsc::Commons::Services::RscServerContext::GetServiceName

(

void

)

const

Gets the service name of the service.

Returns

The service name of the service.

GetServiceProviderName()

const char * Arp::Base::Rsc::Commons::Services::RscServerContext::GetServiceProviderName

(

void

)

const

Gets the service provider name of the service.

Returns

The service name provider of the service.

HasSecurity()

bool Arp::Base::Rsc::Commons::Services::RscServerContext::HasSecurity

(

void

)

const

Determines if the RSC session (connection) requires security.

Returns

true if the RSC session (connection) requires security, otherwise false.

Service calls from external clients always requires security

IsSecure()

bool Arp::Base::Rsc::Commons::Services::RscServerContext::IsSecure

(

void

)

const

Determines if security is applied for this service call from within the client.

Returns

true if security is applied for this service call from within the client, otherwise false.

operator=()

RscServerContext & Arp::Base::Rsc::Commons::Services::RscServerContext::operator= ( RscServerContext &&  arg )

defaultnoexcept

The default move-assignment operator.

Parameters

arg	The argument to move.

Returns

This instance.

---

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

• Arp/Base/Rsc/Commons/Services/RscServerContext.hpp
• Arp/Base/Rsc/Commons/Services/RscServerContext.cpp