sopc_services_api.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_SERVICES_API_H_
#define SOPC_SERVICES_API_H_
 
#include <stdint.h>
 
#include "sopc_event_handler.h"
 
typedef enum SOPC_Services_Event
{
    /* Services to services events */
    SE_TO_SE_SC_ALL_DISCONNECTED =
        0x600,                          
    SE_TO_SE_ACTIVATE_ORPHANED_SESSION, 
    SE_TO_SE_CREATE_SESSION,            
    SE_TO_SE_ACTIVATE_SESSION,          
    SE_TO_SE_SERVER_DATA_CHANGED, 
    SE_TO_SE_SERVER_NODE_CHANGED, 
    SE_TO_SE_SERVER_INACTIVATED_SESSION_PRIO, 
    SE_TO_SE_SERVER_SEND_ASYNC_PUB_RESP_PRIO, 
    /* Timer to services events */
    TIMER_SE_EVAL_SESSION_TIMEOUT,  
    TIMER_SE_PUBLISH_CYCLE_TIMEOUT, 
    /* App to Services events : server side */
    APP_TO_SE_OPEN_ENDPOINT,         
    APP_TO_SE_CLOSE_ENDPOINT,        
    APP_TO_SE_LOCAL_SERVICE_REQUEST, 
    APP_TO_SE_TRIGGER_EVENT,         
    /* App to Services events : client side */
    APP_TO_SE_OPEN_REVERSE_ENDPOINT,  
    APP_TO_SE_CLOSE_REVERSE_ENDPOINT, 
    APP_TO_SE_ACTIVATE_SESSION,       
    APP_TO_SE_SEND_SESSION_REQUEST,   
    APP_TO_SE_SEND_DISCOVERY_REQUEST, 
    APP_TO_SE_CLOSE_SESSION,          
    APP_TO_SE_CLOSE_ALL_CONNECTIONS,  
    APP_TO_SE_REEVALUATE_SCS,         
    APP_TO_SE_EVAL_USR_CRT_SESSIONS,  
} SOPC_Services_Event;
 
/* API to enqueue an event for services */
void SOPC_Services_EnqueueEvent(SOPC_Services_Event seEvent, uint32_t id, uintptr_t params, uintptr_t auxParam);
 
void SOPC_Services_Initialize(SOPC_SetListenerFunc* setSecureChannelsListener);
 
void SOPC_Services_CloseAllSCs(bool clientOnly);
 
void SOPC_Services_Clear(void);
 
// Internal use only (timers)
SOPC_EventHandler* SOPC_Services_GetEventHandler(void);
 
#endif /* SOPC_SERVICES_API_H_ */