summaryrefslogtreecommitdiffstats
path: root/Src/IP/MostIpc.h
blob: 0f8596d49a090708882e40324e88a8781787751c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*
 * Video On Demand Samples
 *
 * Copyright (C) 2015 Microchip Technology Germany II GmbH & Co. KG
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * You may also obtain this software under a propriety license from Microchip.
 * Please contact Microchip for further information.
 *
 */

/*----------------------------------------------------------*/
/*! \file
 *  \brief  This file contains the CMostIpc class.
 */
/*----------------------------------------------------------*/
#ifndef IPC_H
#define IPC_H

#include <stdbool.h>
#include <pthread.h>
#include <semaphore.h>
#include "SafeVector.h"
#include "MsgAddr.h"
#include "MostMsgTx.h"
#include "MsgAddr.h"
#include "MsgFilter.h"

class CMostIpc;

/*! \cond PRIVATE */
typedef struct
{
    pthread_t workerThread;
    CMostIpc *ipc;
    int clientSock;
    char clientIP[46];
    uint32_t clientPort;
} TcpClientInfo_t;
/*! \endcond */

/*----------------------------------------------------------*/
/*!
 * \brief  Inter Process Communication
 *         1. sends messages using MOST protocol over UDP
 *         2. receives messages and forwards them to their
 *            handlers
 */
/*----------------------------------------------------------*/
class CMostIpc
{
private:
    bool isServer;
    bool allowThreadRun;
    bool udpRxThreadIsRunning;
    bool txThreadIsRunning;
    bool acceptThreadIsRunning;
    CSafeVector<CMostMsgTx *> m_MsgTxQueue;
    CSafeVector<CMsgFilter *> m_MsgFilterQueue;
    CSafeVector<TcpClientInfo_t *> m_TcpClientConnections;
    pthread_mutex_t critical_mutex_rx;
    pthread_mutex_t critical_mutex_tcp;
    sem_t semTx;
    int udpSock;
    int tcpSock;

    /*----------------------------------------------------------*/
    /*! \brief TCP accept thread
     *  \note Never call this method directly!
     */
    /*----------------------------------------------------------*/
    static void *TcpAcceptThread( void *pInst );

    /*----------------------------------------------------------*/
    /*! \brief TCP read / write thread
     *  \note Never call this method directly!
     */
    /*----------------------------------------------------------*/
    static void *TcpWorkerThread( void *pInst );


    /*----------------------------------------------------------*/
    /*! \brief UDP receiving thread
     *  \note Never call this method directly!
     */
    /*----------------------------------------------------------*/
    static void *UdpWorkerRXThread( void *pInst );
    
    /*----------------------------------------------------------*/
    /*! \brief Sending thread
     *  \note Never call this method directly!
     */
    /*----------------------------------------------------------*/
    static void *TXThread( void *pInst );

    /*----------------------------------------------------------*/
    /*! \brief handle a received message
     */
    /*----------------------------------------------------------*/
    void OnMsgReceived( CMsgAddr *Addr, CMostMsg *msg );

    bool SendUdp( const char *ipAddress, uint32_t port, const uint8_t *buffer, uint32_t bufferLen );
    bool SendTcp( const char *ipAddress, uint32_t port, const uint8_t *buffer, uint32_t bufferLen );

public:


    /*----------------------------------------------------------*/
    /*! \brief constructs Inter Process Communication, which acts as Server
     *  \param port - If set to server by isServer=true, this value is the server port which the UDP and TCP sockets are listening.
     *                If set to client by isServer=false, this is the client socket port. If set to 0 or below, a random port will be chosen.
     *                Otherwise the given port will be used as source port of the connection. The server always can handle random and fixed client port connections.
     *  \param isServer - true, if this component shall act as "the" server. false, if this component shall act as one of many clients.
     */
    /*----------------------------------------------------------*/
    CMostIpc( int port, bool isServer );

    /*----------------------------------------------------------*/
    /*! \brief Deletes every resources used by Inter Process Communication
     */
    /*----------------------------------------------------------*/
    ~CMostIpc();


    /*----------------------------------------------------------*/
    /*! \brief send a MOST message
     */
    /*----------------------------------------------------------*/
    void SendMsg( CMostMsgTx *Msg );




    /*----------------------------------------------------------*/
    /*! \brief adds a message handler
     */
    /*----------------------------------------------------------*/
    void RegisterMessageHandler( CMsgFilter *Filter );




    /*----------------------------------------------------------*/
    /*! \brief removes a message handler
     */
    /*----------------------------------------------------------*/
    void UnregisterMessageHandler( CMsgFilter *Filter );

};

#endif //IPC_H