sopc_secure_channels_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_SECURE_CHANNELS_API_H_
#define SOPC_SECURE_CHANNELS_API_H_
 
#include <stdint.h>
 
#include "sopc_event_handler.h"
 
typedef enum
{
    EP_OPEN = 0x200,     
    EP_CLOSE,            
    REVERSE_EP_OPEN,     
    REVERSE_EP_CLOSE,    
    SC_CONNECT,          
    SC_REVERSE_CONNECT,  
    SC_DISCONNECT,       
    SC_SERVICE_SND_MSG,  
    SC_SERVICE_SND_ERR,  
    SC_DISCONNECTED_ACK, 
    SCS_REEVALUATE_SCS,  
} SOPC_SecureChannels_InputEvent;
 
typedef enum
{
    EP_CONNECTED = 0x300,  
    EP_CLOSED,             
    EP_REVERSE_CLOSED,     
    SC_CONNECTED,          
    SC_REVERSE_CONNECTED,  
    SC_CONNECTION_TIMEOUT, 
    SC_DISCONNECTED,       
    SC_SERVICE_RCV_MSG,    
    SC_SND_FAILURE,        
    SC_REQUEST_TIMEOUT,    
} SOPC_SecureChannels_OutputEvent;
 
/* Secure channel external event enqueue function
 * IMPORTANT NOTE: internal events use will cause an assertion error */
SOPC_ReturnStatus SOPC_SecureChannels_EnqueueEvent(SOPC_SecureChannels_InputEvent scEvent,
                                                   uint32_t id,
                                                   uintptr_t params,
                                                   uintptr_t auxParam);
 
void SOPC_SecureChannels_Initialize(SOPC_SetListenerFunc* setSocketsListener);
 
void SOPC_SecureChannels_SetEventHandler(SOPC_EventHandler* handler);
 
void SOPC_SecureChannels_Clear(void);
 
#endif /* SOPC_SECURE_CHANNELS_API_H_ */