Source code for connectionmanager/connectionmanager.h

// SPDX-License-Identifier: MIT
#pragma once

#include "connectionmanager/types.h"
#include "elos/libelosplugin/types.h"




[docs]/*******************************************************************
 * Initializes a new ConnectionManager.
 *
 * Parameters:
 *      connectionManager: ConnectionManager structure that will be initialized
 *      plugin: plugin reference to interact with elos.
 * Returns:
 *      - SAFU_RESULT_FAILED on error
 *      - SAFU_RESULT_OK on success
 ******************************************************************/
safuResultE_t elosConnectionManagerInitialize(elosConnectionManager_t *connectionManager, elosPlugin_t *plugin);



[docs]/*******************************************************************
 * Frees member resources used by the given ConnectionManager data structure.
 *
 * Parameters:
 *      connectionManager: ConnectionManager whose members shall be freed
 * Returns:
 *      - SAFU_RESULT_FAILED on error
 *      - SAFU_RESULT_OK on success
 ******************************************************************/
safuResultE_t elosConnectionManagerDeleteMembers(elosConnectionManager_t *connectionManager);



[docs]/*******************************************************************
 * Creates a worker thread waiting for incoming connections.
 * Each ConnectionManager can only handle one worker thread,
 * calling Start a second time will result in an error.
 *
 * Parameters:
 *      connectionManager: ConnectionManager structure to started
 * Returns:
 *      - SAFU_RESULT_FAILED on error
 *      - SAFU_RESULT_OK on success
 ******************************************************************/
safuResultE_t elosConnectionManagerStart(elosConnectionManager_t *connectionManager);



[docs]/*******************************************************************
 * Stops a currently active worker thread.
 *
 * Parameters:
 *      connectionManager: ConnectionManager structure to stopped
 * Returns:
 *      - SAFU_RESULT_FAILED on error
 *      - SAFU_RESULT_OK on success
 ******************************************************************/
safuResultE_t elosConnectionManagerStop(elosConnectionManager_t *connectionManager);