dlt_gateway.h

Go to the documentation of this file.

/*
 * @licence app begin@
 * SPDX license identifier: MPL-2.0
 *
 * Copyright (C) 2015 Advanced Driver Information Technology.
 * This code is developed by Advanced Driver Information Technology.
 * Copyright of Advanced Driver Information Technology, Bosch and DENSO.
 *
 * This file is part of GENIVI Project DLT - Diagnostic Log and Trace.
 *
 * This Source Code Form is subject to the terms of the
 * Mozilla Public License (MPL), 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/.
 *
 * For further information see http://www.genivi.org/.
 * @licence end@
 */

/*******************************************************************************
**                                                                            **
**  SRC-MODULE: dlt_gateway.h                                                 **
**                                                                            **
**  TARGET    : linux                                                         **
**                                                                            **
**  PROJECT   : DLT                                                           **
**                                                                            **
**  AUTHOR    : Christoph Lipka clipka@jp.adit-jv.com                         **
**  PURPOSE   :                                                               **
**                                                                            **
**  REMARKS   :                                                               **
**                                                                            **
**  PLATFORM DEPENDANT [yes/no]: yes                                          **
**                                                                            **
**  TO BE CHANGED BY USER [yes/no]: no                                        **
**                                                                            **
*******************************************************************************/

/*******************************************************************************
**                      Author Identity                                       **
********************************************************************************
**                                                                            **
** Initials     Name                       Company                            **
** --------     -------------------------  ---------------------------------- **
**  cl          Christoph Lipka            ADIT                               **
*******************************************************************************/

#ifndef DLT_GATEWAY_H_
#define DLT_GATEWAY_H_

#include "dlt-daemon.h"
#include "dlt_gateway_types.h"
int dlt_gateway_init(DltDaemonLocal *daemon_local, int verbose);

void dlt_gateway_deinit(DltGateway *g, int verbose);

int dlt_gateway_establish_connections(DltGateway *g,
                                      DltDaemonLocal *daemon_local,
                                      int verbose);

DltReceiver *dlt_gateway_get_connection_receiver(DltGateway *g, int fd);


int dlt_gateway_process_passive_node_messages(DltDaemon *daemon,
                                              DltDaemonLocal *daemon_local,
                                              DltReceiver *recv,
                                              int verbose);

int dlt_gateway_process_gateway_timer(DltDaemon *daemon,
                                      DltDaemonLocal *daemon_local,
                                      DltReceiver *rec,
                                      int verbose);

int dlt_gateway_forward_control_message(DltGateway *g,
                                        DltDaemonLocal *daemon_local,
                                        DltMessage *msg,
                                        char *ecu,
                                        int verbose);

int dlt_gateway_process_on_demand_request(DltGateway *g,
                                          DltDaemonLocal *daemon_local,
                                          char *node_id,
                                          int connection_status,
                                          int verbose);

void dlt_gateway_send_control_message(DltGatewayConnection *con,
                                      DltGateway *g,
                                      DltDaemonLocal *daemon_local,
                                      int verbose);

/* _ONLY_ for development purposes */
void print_gateway_connection_details(const DltGateway *g);
#ifdef DLT_UNIT_TESTS
typedef enum {
    GW_CONF_IP_ADDRESS = 0,
    GW_CONF_PORT,
    GW_CONF_ECUID,
    GW_CONF_CONNECT,
    GW_CONF_TIMEOUT,
    GW_CONF_SEND_CONTROL,
    GW_CONF_SEND_SERIAL_HEADER,
    GW_CONF_COUNT
} DltGatewayConfType;
int dlt_gateway_check_ip(DltGatewayConnection *con, char *value);
int dlt_gateway_check_port(DltGatewayConnection *con, char *value);
int dlt_gateway_check_ecu(DltGatewayConnection *con, char *value);
int dlt_gateway_check_connect_trigger(DltGatewayConnection *con,
                                             char *value);
int dlt_gateway_check_timeout(DltGatewayConnection *con, char *value);
int dlt_gateway_check_send_serial(DltGatewayConnection *con, char *value);
int dlt_gateway_check_control_messages(DltGatewayConnection *con,
                                              char *value);
int dlt_gateway_check_param(DltGateway *gateway,
                                   DltGatewayConnection *con,
                                   DltGatewayConfType ctype,
                                   char *value);
int dlt_gateway_configure(DltGateway *gateway, char *config_file, int verbose);
int dlt_gateway_store_connection(DltGateway *gateway,
                                 DltGatewayConnection *tmp,
                                 int verbose);
#endif
#endif