Remote Call Framework 3.4
RcfFwd.hpp File Reference
#include <functional>
#include <memory>
#include <vector>
#include <RCF/Enums.hpp>

Go to the source code of this file.

Classes

class  RCF::Future< T >
 Provides the ability for remote calls to be executed asynchronously. More...
 
class  RCF::FutureConverter< T >
 Utility class used by RCF to determine whether a remote call should be performed synchronously or asynchronously. More...
 
class  RCF::Publisher< Interface >
 Represents a single publisher within a RcfServer. To create a publisher, use RcfServer::createPublisher(). More...
 

Typedefs

typedef std::unique_ptr< ClientTransport > RCF::ClientTransportUniquePtr
 Unique pointer wrapper for RCF::ClientTransport. More...
 
typedef std::shared_ptr< ServerTransport > RCF::ServerTransportPtr
 Unique pointer wrapper for RCF::ServerTransport. More...
 
typedef std::function< bool(RcfSession &, const std::string &)> RCF::OnSubscriberConnect
 Describes a user-provided callback function to be called on the publisher side, whenever a subscriber connects to a publisher. More...
 
typedef std::function< void(RcfSession &, const std::string &)> RCF::OnSubscriberDisconnect
 Describes a user-provided callback function to be called on the publisher side, whenever a subscriber is disconnected from a publisher. More...
 
typedef std::function< void(RcfSession &)> RCF::OnSubscriptionDisconnect
 Describes a user-provided callback function to be called on the subscriber side, whenever a subscriber is disconnected from a publisher. More...
 
typedef std::function< void(SubscriptionPtr, ExceptionPtr)> RCF::OnAsyncSubscribeCompleted
 Describes a user-provided callback function to be called on the subscriber side, when an subscription is established asynchronously. More...
 
typedef std::function< void(const RemoteCallProgressInfo &, RemoteCallAction &)> RCF::RemoteCallProgressCallback
 Describes a user-provided callback function to be called periodically on the client side, while a remote call is in progress. More...
 
typedef std::shared_ptr< Certificate > RCF::CertificatePtr
 Reference counted wrapper for RCF::Certificate. More...
 
typedef std::function< bool(Certificate *)> RCF::CertificateValidationCallback
 Describes user-provided callback functions for validating a certificate. More...
 
typedef std::shared_ptr< Endpoint > RCF::EndpointPtr
 Reference counted wrapper for RCF::Endpoint. More...
 
typedef std::shared_ptr< BandwidthQuota > RCF::BandwidthQuotaPtr
 Reference counted wrapper for RCF::BandwidthQuota. More...
 
typedef std::function< void(const FileTransferProgress &, RemoteCallAction &)> RCF::FileProgressCallback
 Describes user-provided callback functions for client-side monitoring of a file transfer (download or upload). More...
 
typedef std::function< void(RcfSession &, FileDownloadInfo &)> RCF::DownloadProgressCallback
 Describes user-provided callback functions for server-side monitoring of a file download. More...
 
typedef std::function< void(RcfSession &, FileUploadInfo &)> RCF::UploadProgressCallback
 Describes user-provided callback functions for server-side monitoring of a file upload. More...
 
typedef std::function< BandwidthQuotaPtr(RcfSession &)> RCF::BandwidthQuotaCallback
 Describes user-provided callback functions for assigning custom bandwidth quotas to a RcfSession. More...
 
typedef BandwidthQuotaCallback RCF::UploadBandwidthQuotaCallback
 Describes user-provided callback functions for assigning custom bandwidth quotas to a RcfSession. More...
 
typedef BandwidthQuotaCallback RCF::DownloadBandwidthQuotaCallback
 Describes user-provided callback functions for assigning custom bandwidth quotas to a RcfSession. More...
 
typedef std::shared_ptr< ServerBinding > RCF::ServerBindingPtr
 Reference counted wrapper for RCF::ServerBinding. More...
 
typedef std::shared_ptr< Win32Certificate > RCF::Win32CertificatePtr
 Reference counted wrapper for RCF::Win32Certificate. More...
 
typedef std::function< bool(int)> RCF::AccessControlCallback
 Describes a user-provided function for determining whether a client connections should be able to access a server binding. More...
 
typedef std::function< void(const std::string &statusLine, const HttpHeaderList &headerList)> RCF::HttpRedirectHandler
 Describes a user-provided function for handling HTTP redirect responses when connecting to a HTTP/HTTPS server. More...
 

Typedef Documentation

◆ ClientTransportUniquePtr

typedef std::unique_ptr<ClientTransport> RCF::ClientTransportUniquePtr

Unique pointer wrapper for RCF::ClientTransport.

◆ ServerTransportPtr

typedef std::shared_ptr<ServerTransport> RCF::ServerTransportPtr

Unique pointer wrapper for RCF::ServerTransport.

◆ OnSubscriberConnect

typedef std::function<bool(RcfSession &, const std::string &)> RCF::OnSubscriberConnect

Describes a user-provided callback function to be called on the publisher side, whenever a subscriber connects to a publisher.

◆ OnSubscriberDisconnect

typedef std::function<void(RcfSession &, const std::string &)> RCF::OnSubscriberDisconnect

Describes a user-provided callback function to be called on the publisher side, whenever a subscriber is disconnected from a publisher.

◆ OnSubscriptionDisconnect

typedef std::function<void(RcfSession &)> RCF::OnSubscriptionDisconnect

Describes a user-provided callback function to be called on the subscriber side, whenever a subscriber is disconnected from a publisher.

◆ OnAsyncSubscribeCompleted

typedef std::function<void(SubscriptionPtr, ExceptionPtr)> RCF::OnAsyncSubscribeCompleted

Describes a user-provided callback function to be called on the subscriber side, when an subscription is established asynchronously.

◆ RemoteCallProgressCallback

typedef std::function<void(const RemoteCallProgressInfo&, RemoteCallAction&)> RCF::RemoteCallProgressCallback

Describes a user-provided callback function to be called periodically on the client side, while a remote call is in progress.

◆ CertificatePtr

typedef std::shared_ptr<Certificate> RCF::CertificatePtr

Reference counted wrapper for RCF::Certificate.

◆ CertificateValidationCallback

typedef std::function<bool(Certificate *)> RCF::CertificateValidationCallback

Describes user-provided callback functions for validating a certificate.

◆ EndpointPtr

typedef std::shared_ptr<Endpoint> RCF::EndpointPtr

Reference counted wrapper for RCF::Endpoint.

◆ BandwidthQuotaPtr

typedef std::shared_ptr< BandwidthQuota > RCF::BandwidthQuotaPtr

Reference counted wrapper for RCF::BandwidthQuota.

◆ FileProgressCallback

typedef std::function<void(const FileTransferProgress &, RemoteCallAction&)> RCF::FileProgressCallback

Describes user-provided callback functions for client-side monitoring of a file transfer (download or upload).

◆ DownloadProgressCallback

typedef std::function<void(RcfSession&, FileDownloadInfo &)> RCF::DownloadProgressCallback

Describes user-provided callback functions for server-side monitoring of a file download.

◆ UploadProgressCallback

typedef std::function<void(RcfSession&, FileUploadInfo &)> RCF::UploadProgressCallback

Describes user-provided callback functions for server-side monitoring of a file upload.

◆ BandwidthQuotaCallback

typedef std::function<BandwidthQuotaPtr(RcfSession &)> RCF::BandwidthQuotaCallback

Describes user-provided callback functions for assigning custom bandwidth quotas to a RcfSession.

◆ UploadBandwidthQuotaCallback

typedef BandwidthQuotaCallback RCF::UploadBandwidthQuotaCallback

Describes user-provided callback functions for assigning custom bandwidth quotas to a RcfSession.

◆ DownloadBandwidthQuotaCallback

typedef BandwidthQuotaCallback RCF::DownloadBandwidthQuotaCallback

Describes user-provided callback functions for assigning custom bandwidth quotas to a RcfSession.

◆ ServerBindingPtr

typedef std::shared_ptr< ServerBinding > RCF::ServerBindingPtr

Reference counted wrapper for RCF::ServerBinding.

◆ Win32CertificatePtr

typedef std::shared_ptr<Win32Certificate> RCF::Win32CertificatePtr

Reference counted wrapper for RCF::Win32Certificate.

◆ AccessControlCallback

typedef std::function<bool(int)> RCF::AccessControlCallback

Describes a user-provided function for determining whether a client connections should be able to access a server binding.

◆ HttpRedirectHandler

typedef std::function<void(const std::string & statusLine, const HttpHeaderList& headerList)> RCF::HttpRedirectHandler

Describes a user-provided function for handling HTTP redirect responses when connecting to a HTTP/HTTPS server.