PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | List of all members
Arp::Base::Rsc::Commons::Services::RscClientContext Class Reference

RSC wrapper class of Remoting client context. More...

#include <RscClientContext.hpp>

Public Types

using ReadDelegate = delegate< void(RscReader &)>
 The RSC read data delegate type.
 
using WriteDelegate = delegate< void(RscWriter &)>
 The RSC write data delegate type.
 

Public Member Functions

 RscClientContext (IRscServiceProxy &serviceProxy, RscHandle methodHandle, const char *methodName)
 RSC context for client calls. More...
 
 RscClientContext (const RscClientContext &arg)=delete
 
 RscClientContext (RscClientContext &&arg) noexcept=delete
 
RscClientContextoperator= (const RscClientContext &)=delete
 
RscClientContextoperator= (RscClientContext &&) noexcept=delete
 
 ~RscClientContext (void)
 Destructs this instance.
 
RscReaderGetReader (void)
 Gets the RSC reader of this instance. More...
 
RscWriterGetWriter (void)
 Gets the RSC writer of this instance. More...
 
void SendRequest (WriteDelegate writeFunction)
 Sends the request of the service call. More...
 
void ReceiveResponse (ReadDelegate readFunction)
 Receives the response of the service call. More...
 

Detailed Description

RSC wrapper class of Remoting client context.

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

Constructor & Destructor Documentation

◆ RscClientContext()

Arp::Base::Rsc::Commons::Services::RscClientContext::RscClientContext ( IRscServiceProxy serviceProxy,
RscHandle  methodHandle,
const char *  methodName 
)

RSC context for client calls.

Parameters
serviceProxyThe service proxy to use.
methodHandleThe method handle of the operation to call.
methodNameThe method name of the operation to call.

Member Function Documentation

◆ GetReader()

RscReader & Arp::Base::Rsc::Commons::Services::RscClientContext::GetReader ( void  )

Gets the RSC reader of this instance.

Returns
The RSC reader of this instance.

◆ GetWriter()

RscWriter & Arp::Base::Rsc::Commons::Services::RscClientContext::GetWriter ( void  )

Gets the RSC writer of this instance.

Returns
The RSC writer of this instance.

◆ ReceiveResponse()

void Arp::Base::Rsc::Commons::Services::RscClientContext::ReceiveResponse ( ReadDelegate  readFunction)

Receives the response of the service call.

Parameters
readFunctionThe delegate to read the response data.

◆ SendRequest()

void Arp::Base::Rsc::Commons::Services::RscClientContext::SendRequest ( WriteDelegate  writeFunction)

Sends the request of the service call.

Parameters
writeFunctionThe delegate to write the request data.

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