open62541/src/server/ua_asyncmethod_manager.h

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
  *    Copyright 2019 (c) Fraunhofer IOSB (Author: Klaus Schick)
 * based on
 *    Copyright 2014-2017 (c) Fraunhofer IOSB (Author: Julius Pfrommer)
 *    Copyright 2014, 2017 (c) Florian Palm
 *    Copyright 2015 (c) Sten Grüner
 *    Copyright 2015 (c) Oleksiy Vasylyev
 *    Copyright 2017 (c) Stefan Profanter, fortiss GmbH
 */

#ifndef UA_ASYNCMETHOD_MANAGER_H_
#define UA_ASYNCMETHOD_MANAGER_H_

#include <open62541/server.h>

#include "open62541_queue.h"
#include "ua_session.h"
#include "ua_util_internal.h"
#include "ua_workqueue.h"

#if UA_MULTITHREADING >= 100

_UA_BEGIN_DECLS

typedef struct asyncmethod_list_entry {
    LIST_ENTRY(asyncmethod_list_entry) pointers;
    UA_UInt32 requestId;
    UA_NodeId sessionId;
    UA_UInt32 requestHandle;
    const UA_DataType *responseType;
    UA_DateTime	dispatchTime;       /* Creation time */
    UA_UInt32 nCountdown;			/* Counter for open UA_CallResults */
    UA_CallResponse response;		/* The 'collected' CallResponse for our CallMethodResponse(s) */
} asyncmethod_list_entry;

typedef struct UA_AsyncMethodManager {
    LIST_HEAD(asyncmethod_list, asyncmethod_list_entry) asyncmethods; // doubly-linked list of CallRequests/Responses
    UA_UInt32 currentCount;
} UA_AsyncMethodManager;

UA_StatusCode
UA_AsyncMethodManager_init(UA_AsyncMethodManager *amm);

/* Deletes all entries */
void UA_AsyncMethodManager_deleteMembers(UA_AsyncMethodManager *amm);

UA_StatusCode
UA_AsyncMethodManager_createEntry(UA_AsyncMethodManager *amm, UA_Server *server,
                                  const UA_NodeId *sessionId, const UA_UInt32 channelId,
                                  const UA_UInt32 requestId, const UA_UInt32 requestHandle,
                                  const UA_DataType *responseType, const UA_UInt32 nCountdown);

/* The pointers amm and current must not be NULL */
UA_StatusCode
UA_AsyncMethodManager_removeEntry(UA_AsyncMethodManager *amm, asyncmethod_list_entry *current);

asyncmethod_list_entry*
UA_AsyncMethodManager_getById(UA_AsyncMethodManager *amm, const UA_UInt32 requestId, const UA_NodeId *sessionId);

void
UA_AsyncMethodManager_checkTimeouts(UA_Server *server, UA_AsyncMethodManager *amm);

_UA_END_DECLS

#endif

#endif /* UA_ASYNCMETHOD_MANAGER_H_ */