nx_server_plugin_sdk 1.0 Server Plugin SDK

Public Member Functions | List of all members
nx::sdk::cloud_storage::IBucketDescriptionList Class Referenceabstract

`#include <i_async_operation_handler.h>`

Inheritance diagram for nx::sdk::cloud_storage::IBucketDescriptionList:

## Public Member Functions
virtual int | urlLen () const =0
virtual bool | get (char *url, int *bucketId) const =0
Public Member Functions inherited from nx::sdk::Interface< IBucketDescriptionList >
virtual IRefCountable * | queryInterface (const InterfaceId *id)
Ptr< Interface > | queryInterface ()
Ptr< const Interface > | queryInterface () const
Public Member Functions inherited from nx::sdk::IRefCountable
virtual | ~IRefCountable ()=default
template<class Interface >
Ptr< Interface > | queryInterface ()
template<class Interface >
Ptr< const Interface > | queryInterface () const
virtual int | addRef () const =0
virtual int | releaseRef () const =0
int | refCountThreadUnsafe () const
Public Member Functions inherited from nx::sdk::cloud_storage::IDataList
virtual void | goToBeginning () const =0
virtual void | next () const =0
virtual bool | atEnd () const =0

## Additional Inherited Members
Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto | interfaceId ()
Protected Member Functions inherited from nx::sdk::Interface< IBucketDescriptionList >
virtual IRefCountable * | queryInterface (const IRefCountable::InterfaceId *id) override
IRefCountable * | queryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static const InterfaceId * | makeId (const char(&charArray)[len])
template<int len, int alternativeLen>
static std::vector< const InterfaceId * > | makeIdWithAlternative (const char(&charArray)[len], const char(&alternativeCharArray)[alternativeLen])
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceId * | makeIdForTemplate (const char(&baseIdCharArray)[len])
static std::vector< const InterfaceId * > | alternativeInterfaceIds (const InterfaceId *id)
static std::vector< const InterfaceId * > | alternativeInterfaceIds (std::vector< const InterfaceId *> ids)

## Detailed Description

Storage bucket description. Each media file might be stored on a separate bucket. Media files are reported with the bucket id index, this struct provides a way to resolve this index to the actual bucket url. This url must be used when fetching media files back using the IDeviceAgent::createStreamReader() function.

## Member Function Documentation

## ◆ urlLen()

virtual int nx::sdk::cloud_storage::IBucketDescriptionList::urlLen | ( |  | ) | const
| pure virtual

Must be called before get() to obtain Url length. If there's no next element, this function will return -1;

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

- src/nx/sdk/cloud_storage/i_async_operation_handler.h