nx_metadata_sdk  1.0
Metadata SDK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
nx::sdk::IUtilityProvider Class Referenceabstract
Inheritance diagram for nx::sdk::IUtilityProvider:
nx::sdk::Interface< IUtilityProvider, IUtilityProvider3 > nx::sdk::IUtilityProvider3 nx::sdk::Interface< IUtilityProvider3, IUtilityProvider2 > nx::sdk::IUtilityProvider2 nx::sdk::Interface< IUtilityProvider2, IUtilityProvider1 > nx::sdk::IUtilityProvider1 nx::sdk::Interface< IUtilityProvider1, IUtilityProvider0 > nx::sdk::IUtilityProvider0 nx::sdk::Interface< IUtilityProvider0 > nx::sdk::IRefCountable nx::sdk::RefCountable< IUtilityProvider > nx::vms_server_plugins::analytics::test::UtilityProvider

Classes

class  IHttpRequestCompletionHandler
 

Public Types

enum  HttpDomainName : int { cloud, vms }
 
using IHttpRequestCompletionHandler0 = IHttpRequestCompletionHandler
 

Public Member Functions

void sendHttpRequest (HttpDomainName requestDomainName, const char *path, const char *httpMethod, const char *mimeType, const char *requestBody, Ptr< IHttpRequestCompletionHandler > callback) const
 
- Public Member Functions inherited from nx::sdk::Interface< IUtilityProvider, IUtilityProvider3 >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< RefCountablequeryInterface ()
 
Ptr< const RefCountablequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IUtilityProvider3
virtual IStringcloudSystemId () const =0
 
virtual IStringcloudAuthKey () const =0
 
- Public Member Functions inherited from nx::sdk::Interface< IUtilityProvider3, IUtilityProvider2 >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< RefCountablequeryInterface ()
 
Ptr< const RefCountablequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IUtilityProvider2
virtual const char * serverId () const =0
 
- Public Member Functions inherited from nx::sdk::Interface< IUtilityProvider2, IUtilityProvider1 >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< RefCountablequeryInterface ()
 
Ptr< const RefCountablequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IUtilityProvider1
std::string serverSdkVersion () const
 
- Public Member Functions inherited from nx::sdk::Interface< IUtilityProvider1, IUtilityProvider0 >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< RefCountablequeryInterface ()
 
Ptr< const RefCountablequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IUtilityProvider0
virtual int64_t vmsSystemTimeSinceEpochMs () const =0
 
std::string homeDir () const
 
- Public Member Functions inherited from nx::sdk::Interface< IUtilityProvider0 >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< RefCountablequeryInterface ()
 
Ptr< const RefCountablequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
template<class RefCountable >
Ptr< RefCountablequeryInterface ()
 
template<class RefCountable >
Ptr< const RefCountablequeryInterface () const
 
virtual int addRef () const =0
 
virtual int releaseRef () const =0
 
int refCountThreadUnsafe () const
 

Static Public Member Functions

static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IUtilityProvider3
static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IUtilityProvider2
static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IUtilityProvider1
static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IUtilityProvider0
static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 

Protected Member Functions

virtual void doSendHttpRequest (HttpDomainName requestDomainName, const char *path, const char *httpMethod, const char *mimeType, const char *requestBody, IHttpRequestCompletionHandler *callback) const =0
 
- Protected Member Functions inherited from nx::sdk::Interface< IUtilityProvider, IUtilityProvider3 >
virtual IRefCountablequeryInterface (const IRefCountable::InterfaceId *id) override
 
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 
- Protected Member Functions inherited from nx::sdk::Interface< IUtilityProvider3, IUtilityProvider2 >
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 
- Protected Member Functions inherited from nx::sdk::Interface< IUtilityProvider2, IUtilityProvider1 >
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 
- Protected Member Functions inherited from nx::sdk::IUtilityProvider1
virtual const IStringgetServerSdkVersion () const =0
 
- Protected Member Functions inherited from nx::sdk::Interface< IUtilityProvider1, IUtilityProvider0 >
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 
- Protected Member Functions inherited from nx::sdk::IUtilityProvider0
virtual const IStringgetHomeDir () const =0
 
- Protected Member Functions inherited from nx::sdk::Interface< IUtilityProvider0 >
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 

Additional Inherited Members

- Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static constexpr const InterfaceIdmakeId (const char(&charArray)[len])
 
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceIdmakeIdForTemplate (const char(&baseIdCharArray)[len])
 
- Static Protected Attributes inherited from nx::sdk::IRefCountable
template<typename RefCountable >
static constexpr bool hasAlternativeInterfaceId = HasAlternativeInterfaceId<RefCountable>::value
 

Member Function Documentation

◆ doSendHttpRequest()

virtual void nx::sdk::IUtilityProvider::doSendHttpRequest ( HttpDomainName  requestDomainName,
const char *  path,
const char *  httpMethod,
const char *  mimeType,
const char *  requestBody,
IHttpRequestCompletionHandler callback 
) const
protectedpure virtual

◆ sendHttpRequest()

void nx::sdk::IUtilityProvider::sendHttpRequest ( HttpDomainName  requestDomainName,
const char *  path,
const char *  httpMethod,
const char *  mimeType,
const char *  requestBody,
Ptr< IHttpRequestCompletionHandler callback 
) const
inline

Allows to send asynchronous HTTP requests to the Cloud or VMS Server. IHttpRequestCompletionHandler::execute() will be called later. An error or HTTP response will be passed to this method as a parameter. HTTP response will consist of a status line, HTTP headers and a message body seperated by an empty line.


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