server.h

Go to the documentation of this file.

/************************************************************************************************************************
 Copyright (c) 2016, Imagination Technologies Limited and/or its affiliated group companies.
 All rights reserved.

 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 following conditions are met:
     1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
        following disclaimer.
     2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
        following disclaimer in the documentation and/or other materials provided with the distribution.
     3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
        products derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
************************************************************************************************************************/

#ifndef AWA_SERVER_H
#define AWA_SERVER_H

// @cond
#include <stdbool.h>
// @endcond

#include "common.h"

#ifdef __cplusplus
extern "C" {
#endif

/**************************************************************************************************
 * Example Usage
 *************************************************************************************************/

/**************************************************************************************************
 * Public Types and Enumerations
 *************************************************************************************************/

typedef enum
{
    AwaWriteMode_Replace = 0,  
    AwaWriteMode_Update,       
    AwaWriteMode_LAST,         
} AwaWriteMode;

typedef struct _AwaServerSession AwaServerSession;
typedef struct _AwaServerListClientsOperation AwaServerListClientsOperation;
typedef struct _AwaServerListClientsResponse AwaServerListClientsResponse;
typedef struct _AwaClientIterator AwaClientIterator;
typedef struct _AwaRegisteredEntityIterator AwaRegisteredEntityIterator;
typedef struct _AwaServerDefineOperation AwaServerDefineOperation;
typedef struct _AwaServerDefineResponse AwaServerDefineResponse;
typedef struct _AwaServerReadOperation AwaServerReadOperation;
typedef struct _AwaServerReadResponse AwaServerReadResponse;
typedef struct _AwaServerWriteOperation AwaServerWriteOperation;
typedef struct _AwaWriteResponse AwaServerWriteResponse;
typedef struct _AwaServerDeleteResponse AwaServerDeleteResponse;
typedef struct _AwaServerDeleteOperation AwaServerDeleteOperation;
typedef struct _AwaServerExecuteOperation AwaServerExecuteOperation;
typedef struct _AwaServerExecuteResponse AwaServerExecuteResponse;
typedef struct _AwaServerWriteAttributesOperation AwaServerWriteAttributesOperation;
typedef struct _AwaServerWriteAttributesResponse AwaServerWriteAttributesResponse;
typedef struct _AwaServerDiscoverOperation AwaServerDiscoverOperation;
typedef struct _AwaServerDiscoverResponse AwaServerDiscoverResponse;
typedef struct _AwaAttributeIterator AwaAttributeIterator;
typedef struct _AwaServerObserveOperation AwaServerObserveOperation;
typedef struct _AwaServerObservation AwaServerObservation;
typedef struct _AwaServerObserveResponse AwaServerObserveResponse;
typedef struct _AwaServerClientRegisterEvent AwaServerClientRegisterEvent;
typedef struct _AwaServerClientUpdateEvent AwaServerClientUpdateEvent;
typedef struct _AwaServerClientDeregisterEvent AwaServerClientDeregisterEvent;


/**************************************************************************************************
 * Callbacks
 *************************************************************************************************/

typedef void (*AwaServerObservationCallback)(const AwaChangeSet * changeSet, void * context);

typedef void (*AwaServerClientRegisterEventCallback)(const AwaServerClientRegisterEvent * event, void * context);

typedef void (*AwaServerClientUpdateEventCallback)(const AwaServerClientUpdateEvent * event, void * context);

typedef void (*AwaServerClientDeregisterEventCallback)(const AwaServerClientDeregisterEvent * event, void * context);


/**************************************************************************************************
 * Server Session Management
 *************************************************************************************************/

AwaServerSession * AwaServerSession_New(void);

AwaError AwaServerSession_SetIPCAsUDP(AwaServerSession * session, const char * address, unsigned short port);

// Not yet implemented:
//AwaError AwaServerSession_SetIPCAsLocal(AwaServerSession * session);
//AwaError AwaServerSession_SetIPCAsMQTT(AwaServerSession * session /* ... */);
//AwaError AwaServerSession_SetIPCAsUbus(AwaServerSession * session /* ... */);
//AwaError AwaServerSession_SetIPCAsNanoMsg(AwaServerSession * session /* ... */);
//AwaError AwaServerSession_SetIPCAsREST(AwaServerSession * session /* ... */);

AwaError AwaServerSession_SetDefaultTimeout(AwaServerSession * session, AwaTimeout timeout);

AwaError AwaServerSession_Connect(AwaServerSession * session);

AwaError AwaServerSession_Refresh(AwaServerSession * session);

bool AwaServerSession_IsObjectDefined(const AwaServerSession * session, AwaObjectID objectID);

const AwaObjectDefinition * AwaServerSession_GetObjectDefinition(const AwaServerSession * session, AwaObjectID objectID);

AwaObjectDefinitionIterator * AwaServerSession_NewObjectDefinitionIterator(const AwaServerSession * session);

AwaError AwaServerSession_Process(AwaServerSession * session, AwaTimeout timeout);

AwaError AwaServerSession_DispatchCallbacks(AwaServerSession * session);

AwaError AwaServerSession_Disconnect(AwaServerSession * session);

AwaError AwaServerSession_Free(AwaServerSession ** session);

AwaError AwaServerSession_PathToIDs(const AwaServerSession * session, const char * path, AwaObjectID * objectID, AwaObjectInstanceID * objectInstanceID, AwaResourceID * resourceID);


/**************************************************************************************************
 * List Clients Operation
 *************************************************************************************************/

AwaServerListClientsOperation * AwaServerListClientsOperation_New(const AwaServerSession * session);

AwaError AwaServerListClientsOperation_Perform(AwaServerListClientsOperation * operation, AwaTimeout timeout);

const AwaServerListClientsResponse * AwaServerListClientsOperation_GetResponse(const AwaServerListClientsOperation * operation, const char * clientID);

AwaRegisteredEntityIterator * AwaServerListClientsResponse_NewRegisteredEntityIterator(const AwaServerListClientsResponse * response);

AwaError AwaServerListClientsOperation_Free(AwaServerListClientsOperation ** operation);

bool AwaClientIterator_Next(AwaClientIterator * iterator);

const char * AwaClientIterator_GetClientID(const AwaClientIterator * iterator);

void AwaClientIterator_Free(AwaClientIterator ** iterator);

AwaClientIterator * AwaServerListClientsOperation_NewClientIterator(const AwaServerListClientsOperation * operation);

bool AwaRegisteredEntityIterator_Next(AwaRegisteredEntityIterator * iterator);

const char * AwaRegisteredEntityIterator_GetPath(const AwaRegisteredEntityIterator * iterator);

void AwaRegisteredEntityIterator_Free(AwaRegisteredEntityIterator ** iterator);


/**************************************************************************************************
 * Object & Resource Definition Operation
 *************************************************************************************************/

AwaServerDefineOperation * AwaServerDefineOperation_New(const AwaServerSession * session);

AwaError AwaServerDefineOperation_Add(AwaServerDefineOperation * operation, const AwaObjectDefinition * objectDefinition);

// Future: support per-client definitions:
//AwaError AwaServerDefineOperation_AddWithClient(AwaServerDefineOperation * operation, const char * clientID, const AwaObjectDefinition * objectDefinition);

/*
 * @brief Process the Define operation by sending it to the Core.
 *        If successful, the object definition is also added to the session.
 * @param[in] operation The Define operation to process.
 * @param[in] timeout The function will wait at least as long as this value for a response.
 * @return AwaError_Success on success.
 * @return AwaError_Timeout if no response is received after the timeout duration expires.
 * @return Various errors on failure.
 */
AwaError AwaServerDefineOperation_Perform(AwaServerDefineOperation * operation, AwaTimeout timeout);

AwaError AwaServerDefineOperation_Free(AwaServerDefineOperation ** operation);

const AwaServerDefineResponse * AwaServerDefineOperation_GetResponse(const AwaServerDefineOperation * operation);

AwaPathIterator * AwaServerDefineResponse_NewPathIterator(const AwaServerDefineResponse * response);

const AwaPathResult * AwaServerDefineResponse_GetPathResult(const AwaServerDefineResponse * response, const char * path);

bool AwaServerDefineResponse_ContainsPath(const AwaServerDefineResponse * response, const char * path);


/**************************************************************************************************
 * Object & Resource Retrieval Operation
 *************************************************************************************************/

AwaServerReadOperation * AwaServerReadOperation_New(const AwaServerSession * session);

AwaError AwaServerReadOperation_AddPath(AwaServerReadOperation * operation, const char * clientID, const char * path);

AwaError AwaServerReadOperation_Perform(AwaServerReadOperation * operation, AwaTimeout timeout);

AwaError AwaServerReadOperation_Free(AwaServerReadOperation ** operation);

AwaClientIterator * AwaServerReadOperation_NewClientIterator(const AwaServerReadOperation * operation);

const AwaServerReadResponse * AwaServerReadOperation_GetResponse(const AwaServerReadOperation * operation, const char * clientID);

AwaPathIterator * AwaServerReadResponse_NewPathIterator(const AwaServerReadResponse * response);

const AwaPathResult * AwaServerReadResponse_GetPathResult(const AwaServerReadResponse * response, const char * path);

bool AwaServerReadResponse_ContainsPath(const AwaServerReadResponse * response, const char * path);

bool AwaServerReadResponse_HasValue(const AwaServerReadResponse * response, const char * path);

AwaError AwaServerReadResponse_GetValueAsCStringPointer    (const AwaServerReadResponse * response, const char * path, const char ** value);
AwaError AwaServerReadResponse_GetValueAsIntegerPointer    (const AwaServerReadResponse * response, const char * path, const AwaInteger ** value);
AwaError AwaServerReadResponse_GetValueAsFloatPointer      (const AwaServerReadResponse * response, const char * path, const AwaFloat ** value);
AwaError AwaServerReadResponse_GetValueAsBooleanPointer    (const AwaServerReadResponse * response, const char * path, const AwaBoolean ** value);
AwaError AwaServerReadResponse_GetValueAsTimePointer       (const AwaServerReadResponse * response, const char * path, const AwaTime ** value);
AwaError AwaServerReadResponse_GetValueAsObjectLinkPointer (const AwaServerReadResponse * response, const char * path, const AwaObjectLink ** value);
AwaError AwaServerReadResponse_GetValueAsOpaquePointer     (const AwaServerReadResponse * response, const char * path, const AwaOpaque ** value);
AwaError AwaServerReadResponse_GetValueAsOpaque(const AwaServerReadResponse * response, const char * path, AwaOpaque * value);

AwaError AwaServerReadResponse_GetValueAsObjectLink(const AwaServerReadResponse * response, const char * path, AwaObjectLink * value);

AwaError AwaServerReadResponse_GetValuesAsStringArrayPointer    (const AwaServerReadResponse * response, const char * path, const AwaStringArray ** valueArray);
AwaError AwaServerReadResponse_GetValuesAsIntegerArrayPointer   (const AwaServerReadResponse * response, const char * path, const AwaIntegerArray ** valueArray);
AwaError AwaServerReadResponse_GetValuesAsFloatArrayPointer     (const AwaServerReadResponse * response, const char * path, const AwaFloatArray ** valueArray);
AwaError AwaServerReadResponse_GetValuesAsBooleanArrayPointer   (const AwaServerReadResponse * response, const char * path, const AwaBooleanArray ** valueArray);
AwaError AwaServerReadResponse_GetValuesAsTimeArrayPointer      (const AwaServerReadResponse * response, const char * path, const AwaTimeArray ** valueArray);
AwaError AwaServerReadResponse_GetValuesAsOpaqueArrayPointer    (const AwaServerReadResponse * response, const char * path, const AwaOpaqueArray ** valueArray);
AwaError AwaServerReadResponse_GetValuesAsObjectLinkArrayPointer(const AwaServerReadResponse * response, const char * path, const AwaObjectLinkArray ** valueArray);
/**************************************************************************************************
 * Object & Resource Value Setting Operation
 *************************************************************************************************/

const char * AwaWriteMode_ToString(AwaWriteMode writeMode);

AwaWriteMode AwaWriteMode_FromString(const char * writeModeString);

AwaServerWriteOperation * AwaServerWriteOperation_New(const AwaServerSession * session, AwaWriteMode defaultMode);

AwaError AwaServerWriteOperation_CreateObjectInstance(AwaServerWriteOperation * operation, const char * path);

AwaError AwaServerWriteOperation_SetObjectInstanceWriteMode(AwaServerWriteOperation * operation, const char * path, AwaWriteMode mode);

AwaError AwaServerWriteOperation_SetResourceWriteMode(AwaServerWriteOperation * operation, const char * path, AwaWriteMode mode);

AwaError AwaServerWriteOperation_AddValueAsCString   (AwaServerWriteOperation * operation, const char * path, const char * value);
AwaError AwaServerWriteOperation_AddValueAsInteger   (AwaServerWriteOperation * operation, const char * path, AwaInteger value);
AwaError AwaServerWriteOperation_AddValueAsFloat     (AwaServerWriteOperation * operation, const char * path, AwaFloat value);
AwaError AwaServerWriteOperation_AddValueAsBoolean   (AwaServerWriteOperation * operation, const char * path, AwaBoolean value);
AwaError AwaServerWriteOperation_AddValueAsTime      (AwaServerWriteOperation * operation, const char * path, AwaTime value);
AwaError AwaServerWriteOperation_AddValueAsOpaque    (AwaServerWriteOperation * operation, const char * path, AwaOpaque value);
AwaError AwaServerWriteOperation_AddValueAsObjectLink(AwaServerWriteOperation * operation, const char * path, AwaObjectLink value);
AwaError AwaServerWriteOperation_AddValueAsStringArray    (AwaServerWriteOperation * operation, const char * path, const AwaStringArray * array);
AwaError AwaServerWriteOperation_AddValueAsIntegerArray   (AwaServerWriteOperation * operation, const char * path, const AwaIntegerArray * array);
AwaError AwaServerWriteOperation_AddValueAsFloatArray     (AwaServerWriteOperation * operation, const char * path, const AwaFloatArray * array);
AwaError AwaServerWriteOperation_AddValueAsBooleanArray   (AwaServerWriteOperation * operation, const char * path, const AwaBooleanArray * array);
AwaError AwaServerWriteOperation_AddValueAsTimeArray      (AwaServerWriteOperation * operation, const char * path, const AwaTimeArray * array);
AwaError AwaServerWriteOperation_AddValueAsOpaqueArray    (AwaServerWriteOperation * operation, const char * path, const AwaOpaqueArray * array);
AwaError AwaServerWriteOperation_AddValueAsObjectLinkArray(AwaServerWriteOperation * operation, const char * path, const AwaObjectLinkArray * array);
AwaError AwaServerWriteOperation_AddArrayValueAsCString   (AwaServerWriteOperation * operation, const char * path, int resourceInstanceID, const char * value);
AwaError AwaServerWriteOperation_AddArrayValueAsInteger   (AwaServerWriteOperation * operation, const char * path, int resourceInstanceID, AwaInteger value);
AwaError AwaServerWriteOperation_AddArrayValueAsFloat     (AwaServerWriteOperation * operation, const char * path, int resourceInstanceID, AwaFloat value);
AwaError AwaServerWriteOperation_AddArrayValueAsBoolean   (AwaServerWriteOperation * operation, const char * path, int resourceInstanceID, AwaBoolean value);
AwaError AwaServerWriteOperation_AddArrayValueAsTime      (AwaServerWriteOperation * operation, const char * path, int resourceInstanceID, AwaTime value);
AwaError AwaServerWriteOperation_AddArrayValueAsOpaque    (AwaServerWriteOperation * operation, const char * path, int resourceInstanceID, AwaOpaque value);
AwaError AwaServerWriteOperation_AddArrayValueAsObjectLink(AwaServerWriteOperation * operation, const char * path, int resourceInstanceID, AwaObjectLink value);
AwaError AwaServerWriteOperation_Perform(AwaServerWriteOperation * operation, const char * clientID, AwaTimeout timeout);

const AwaServerWriteResponse * AwaServerWriteOperation_GetResponse(const AwaServerWriteOperation * operation, const char * clientID);

AwaError AwaServerWriteOperation_Free(AwaServerWriteOperation ** operation);

AwaClientIterator * AwaServerWriteOperation_NewClientIterator(const AwaServerWriteOperation * operation);

AwaPathIterator * AwaServerWriteResponse_NewPathIterator(const AwaServerWriteResponse * response);

const AwaPathResult * AwaServerWriteResponse_GetPathResult(const AwaServerWriteResponse * response, const char * path);

bool AwaServerWriteResponse_ContainsPath(const AwaServerWriteResponse * response, const char * path);


/**************************************************************************************************
 * Object Instance & Resource Deletion Operation
 *************************************************************************************************/

AwaServerDeleteOperation * AwaServerDeleteOperation_New(const AwaServerSession * session);

AwaError AwaServerDeleteOperation_AddPath(AwaServerDeleteOperation * operation, const char * clientID, const char * path);

AwaError AwaServerDeleteOperation_Perform(AwaServerDeleteOperation * operation, AwaTimeout timeout);

const AwaServerDeleteResponse * AwaServerDeleteOperation_GetResponse(const AwaServerDeleteOperation * operation, const char * clientID);

AwaError AwaServerDeleteOperation_Free(AwaServerDeleteOperation ** operation);

AwaClientIterator * AwaServerDeleteOperation_NewClientIterator(const AwaServerDeleteOperation * operation);

AwaPathIterator * AwaServerDeleteResponse_NewPathIterator(const AwaServerDeleteResponse * response);

const AwaPathResult * AwaServerDeleteResponse_GetPathResult(const AwaServerDeleteResponse * response, const char * path);

bool AwaServerDeleteResponse_ContainsPath(const AwaServerDeleteResponse * response, const char * path);


/**************************************************************************************************
 * Resource Execute Operation
 *************************************************************************************************/

AwaServerExecuteOperation * AwaServerExecuteOperation_New(const AwaServerSession * session);

AwaError AwaServerExecuteOperation_AddPath(AwaServerExecuteOperation * operation, const char * clientID, const char * path, const AwaExecuteArguments * arguments);

AwaError AwaServerExecuteOperation_Perform(AwaServerExecuteOperation * operation, AwaTimeout timeout);

const AwaServerExecuteResponse * AwaServerExecuteOperation_GetResponse(const AwaServerExecuteOperation * operation, const char * clientID);

AwaError AwaServerExecuteOperation_Free(AwaServerExecuteOperation ** operation);

AwaClientIterator * AwaServerExecuteOperation_NewClientIterator(const AwaServerExecuteOperation * operation);

AwaPathIterator * AwaServerExecuteResponse_NewPathIterator(const AwaServerExecuteResponse * response);

const AwaPathResult * AwaServerExecuteResponse_GetPathResult(const AwaServerExecuteResponse * response, const char * path);

bool AwaServerExecuteResponse_ContainsPath(const AwaServerExecuteResponse * response, const char * path);


/**************************************************************************************************
 * Write-Attributes Operation
 *************************************************************************************************/

AwaServerWriteAttributesOperation * AwaServerWriteAttributesOperation_New(const AwaServerSession * session);

AwaError AwaServerWriteAttributesOperation_AddAttributeAsInteger   (AwaServerWriteAttributesOperation * operation, const char * clientID, const char * path, const char * link, AwaInteger value);
AwaError AwaServerWriteAttributesOperation_AddAttributeAsFloat     (AwaServerWriteAttributesOperation * operation, const char * clientID, const char * path, const char * link, AwaFloat value);
// not yet implemented:
//AwaError AwaServerWriteAttributesOperation_AddAttributeAsCString   (AwaServerWriteAttributesOperation * operation, const char * path, const char * link, const char * value);
//AwaError AwaServerWriteAttributesOperation_AddAttributeAsBoolean   (AwaServerWriteAttributesOperation * operation, const char * path, const char * link, AwaBoolean value);
//AwaError AwaServerWriteAttributesOperation_AddAttributeAsTime      (AwaServerWriteAttributesOperation * operation, const char * path, const char * link, AwaTime value);
//AwaError AwaServerWriteAttributesOperation_AddAttributeAsOpaque    (AwaServerWriteAttributesOperation * operation, const char * path, const char * link, AwaOpaque value);
//AwaError AwaServerWriteAttributesOperation_AddAttributeAsObjectLink(AwaServerWriteAttributesOperation * operation, const char * path, const char * link, AwaObjectLink value);
AwaError AwaServerWriteAttributesOperation_Perform(AwaServerWriteAttributesOperation * operation, AwaTimeout timeout);

const AwaServerWriteAttributesResponse * AwaServerWriteAttributesOperation_GetResponse(const AwaServerWriteAttributesOperation * operation, const char * clientID);

AwaError AwaServerWriteAttributesOperation_Free(AwaServerWriteAttributesOperation ** operation);

AwaClientIterator * AwaServerWriteAttributesOperation_NewClientIterator(const AwaServerWriteAttributesOperation * operation);

AwaPathIterator * AwaServerWriteAttributesResponse_NewPathIterator(const AwaServerWriteAttributesResponse * response);

const AwaPathResult * AwaServerWriteAttributesResponse_GetPathResult(const AwaServerWriteAttributesResponse * response, const char * path);

bool AwaServerWriteAttributesResponse_ContainsPath(const AwaServerWriteAttributesResponse * response, const char * path);


/**************************************************************************************************
 * Discover Operation
 *************************************************************************************************/

AwaServerDiscoverOperation * AwaServerDiscoverOperation_New(const AwaServerSession * session);

AwaError AwaServerDiscoverOperation_AddPath(AwaServerDiscoverOperation * operation, const char * clientID, const char * path);

AwaError AwaServerDiscoverOperation_Perform(AwaServerDiscoverOperation * operation, AwaTimeout timeout);

const AwaServerDiscoverResponse * AwaServerDiscoverOperation_GetResponse(const AwaServerDiscoverOperation * operation, const char * clientID);

AwaError AwaServerDiscoverOperation_Free(AwaServerDiscoverOperation ** operation);

AwaClientIterator * AwaServerDiscoverOperation_NewClientIterator(const AwaServerDiscoverOperation * operation);

AwaPathIterator * AwaServerDiscoverResponse_NewPathIterator(const AwaServerDiscoverResponse * response);

const AwaPathResult * AwaServerDiscoverResponse_GetPathResult(const AwaServerDiscoverResponse * response, const char * path);

bool AwaServerDiscoverResponse_ContainsPath(const AwaServerDiscoverResponse * response, const char * path);

AwaError AwaServerDiscoverResponse_GetAttributeValueAsIntegerPointer(const AwaServerDiscoverResponse * response, const char * path, const char * link, const AwaInteger ** value);
AwaError AwaServerDiscoverResponse_GetAttributeValueAsFloatPointer  (const AwaServerDiscoverResponse * response, const char * path, const char * link, const AwaFloat ** value);
//AwaError AwaServerDiscoverResponse_GetAttributeValueAsCStringPointer(const AwaServerDiscoverResponse * response, const char * path, const char * link, const char ** value);
//AwaError AwaServerDiscoverResponse_GetAttributeValueAsBooleanPointer(const AwaServerDiscoverResponse * response, const char * path, const char * link, const AwaBoolean ** value);
//AwaError AwaServerDiscoverResponse_GetAttributeValueAsTimePointer   (const AwaServerDiscoverResponse * response, const char * path, const char * link, const AwaTime ** value);
//AwaError AwaServerDiscoverResponse_GetAttributeValueAsOpaque        (const AwaServerDiscoverResponse * response, const char * path, const char * link, AwaOpaque * value);
//AwaError AwaServerDiscoverResponse_GetAttributeValueAsObjectLink    (const AwaServerDiscoverResponse * response, const char * path, const char * link, AwaObjectLink * value);
AwaAttributeIterator * AwaServerDiscoverResponse_NewAttributeIterator(const AwaServerDiscoverResponse * response, const char * path);

bool AwaAttributeIterator_Next(AwaAttributeIterator * iterator);

const char * AwaAttributeIterator_GetLink(const AwaAttributeIterator * iterator);

void AwaAttributeIterator_Free(AwaAttributeIterator ** iterator);


/**************************************************************************************************
 * Observe Operation
 *************************************************************************************************/

AwaServerObserveOperation * AwaServerObserveOperation_New(const AwaServerSession * session);

AwaError AwaServerObserveOperation_AddObservation(AwaServerObserveOperation * operation, AwaServerObservation * observation);

AwaError AwaServerObserveOperation_AddCancelObservation(AwaServerObserveOperation * operation, AwaServerObservation * observation);

AwaError AwaServerObserveOperation_Perform(AwaServerObserveOperation * operation, AwaTimeout timeout);

const AwaServerObserveResponse * AwaServerObserveOperation_GetResponse(const AwaServerObserveOperation * operation, const char * clientID);

AwaError AwaServerObserveOperation_Free(AwaServerObserveOperation ** operation);

AwaServerObservation * AwaServerObservation_New(const char * clientID, const char * path, AwaServerObservationCallback callback, void * context);

const char * AwaServerObservation_GetPath(AwaServerObservation * observation);

AwaError AwaServerObservation_Free(AwaServerObservation ** observation);

AwaClientIterator * AwaServerObserveOperation_NewClientIterator(const AwaServerObserveOperation * operation);

AwaPathIterator * AwaServerObserveResponse_NewPathIterator(const AwaServerObserveResponse * response);

const AwaPathResult * AwaServerObserveResponse_GetPathResult(const AwaServerObserveResponse * response, const char * path);

bool AwaServerObserveResponse_ContainsPath(const AwaServerObserveResponse * response, const char * path);


/**************************************************************************************************
 * ChangeSet Functions for Observations
 *************************************************************************************************/

const AwaServerSession * AwaChangeSet_GetServerSession(const AwaChangeSet * changeSet);

const char * AwaChangeSet_GetClientID(const AwaChangeSet * changeSet);


/**************************************************************************************************
 * Server Events
 *************************************************************************************************/

AwaError AwaServerSession_SetClientRegisterEventCallback(AwaServerSession * session, AwaServerClientRegisterEventCallback callback, void * context);

AwaError AwaServerSession_SetClientUpdateEventCallback(AwaServerSession * session, AwaServerClientUpdateEventCallback callback, void * context);

AwaError AwaServerSession_SetClientDeregisterEventCallback(AwaServerSession * session, AwaServerClientDeregisterEventCallback callback, void * context);

AwaClientIterator * AwaServerClientRegisterEvent_NewClientIterator(const AwaServerClientRegisterEvent * event);

AwaClientIterator * AwaServerClientUpdateEvent_NewClientIterator(const AwaServerClientUpdateEvent * event);

AwaClientIterator * AwaServerClientDeregisterEvent_NewClientIterator(const AwaServerClientDeregisterEvent * event);

AwaRegisteredEntityIterator * AwaServerClientRegisterEvent_NewRegisteredEntityIterator(const AwaServerClientRegisterEvent * event, const char * clientID);

AwaRegisteredEntityIterator * AwaServerClientUpdateEvent_NewRegisteredEntityIterator(const AwaServerClientUpdateEvent * event, const char * clientID);


#ifdef __cplusplus
}
#endif

#endif // AWA_SERVER_H