eRPC API Reference  Rev. 1.9.0
NXP Semiconductors
erpc_transport_arbitrator.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, Freescale Semiconductor, Inc.
3  * Copyright 2016-2017 NXP
4  * All rights reserved.
5  *
6  *
7  * SPDX-License-Identifier: BSD-3-Clause
8  */
9 #if !defined(__embedded_rpc__transport_arbitrator__)
10 #define __embedded_rpc__transport_arbitrator__
11 
12 #include "erpc_client_manager.h"
13 #include "erpc_codec.h"
14 #include "erpc_threading.h"
15 #include "erpc_transport.h"
16 
23 // Classes
26 
27 namespace erpc {
28 class Codec;
29 
41 {
42 public:
44  typedef uintptr_t client_token_t;
45 
49  TransportArbitrator(void);
50 
54  virtual ~TransportArbitrator(void);
55 
61  void setSharedTransport(Transport *shared) { m_sharedTransport = shared; }
62 
68  void setCodec(Codec *codec) { m_codec = codec; }
69 
79  virtual erpc_status_t receive(MessageBuffer *message) override;
80 
92  client_token_t prepareClientReceive(RequestContext &request);
93 
104  erpc_status_t clientReceive(client_token_t token);
105 
115  virtual erpc_status_t send(MessageBuffer *message) override;
116 
122  virtual void setCrc16(Crc16 *crcImpl) override;
123 
130  virtual bool hasMessage(void) override;
131 
136  {
139  bool m_isValid;
145  PendingClientInfo(void);
146 
150  ~PendingClientInfo(void);
151  };
152 
153 protected:
156 
160 
167 
174 
181 
187  void freeClientList(PendingClientInfo *list);
188 };
189 
190 } // namespace erpc
191 
194 #endif // defined(__embedded_rpc__transport_arbitrator__)
195 // EOF
Abstract interface for transport layer.
Definition: erpc_transport.h:36
Interposer to share transport between client and server.
Definition: erpc_transport_arbitrator.h:40
~PendingClientInfo(void)
Destructor.
Definition: erpc_transport_arbitrator.cpp:262
enum _erpc_status erpc_status_t
Type used for all status and error return values.
Definition: erpc_common.h:87
erpc_status_t clientReceive(client_token_t token)
Receive method for the client.
Definition: erpc_transport_arbitrator.cpp:160
PendingClientInfo * createPendingClient(void)
Create a Pending Client object.
Definition: erpc_transport_arbitrator.cpp:175
Abstract serialization encoder/decoder interface.
Definition: erpc_codec.h:53
client_token_t prepareClientReceive(RequestContext &request)
Add a client request to the client list.
Definition: erpc_transport_arbitrator.cpp:149
PendingClientInfo * addPendingClient(void)
This function adds pending client.
Definition: erpc_transport_arbitrator.cpp:178
Request info for a client trying to receive a response.
Definition: erpc_transport_arbitrator.h:135
PendingClientInfo(void)
Constructor.
Definition: erpc_transport_arbitrator.cpp:254
bool m_isValid
Definition: erpc_transport_arbitrator.h:139
Transport * m_sharedTransport
Transport being shared through this arbitrator.
Definition: erpc_transport_arbitrator.h:154
void freeClientList(PendingClientInfo *list)
This function removes pending client list.
Definition: erpc_transport_arbitrator.cpp:241
PendingClientInfo * m_clientFreeList
Unused client receive info structs.
Definition: erpc_transport_arbitrator.h:158
Represents a memory buffer containing a message.
Definition: erpc_message_buffer.h:37
Definition: erpc_arbitrated_client_manager.h:25
PendingClientInfo * m_next
Definition: erpc_transport_arbitrator.h:140
void removePendingClient(PendingClientInfo *info)
This function removes pending client.
Definition: erpc_transport_arbitrator.cpp:208
virtual ~TransportArbitrator(void)
Destructor.
Definition: erpc_transport_arbitrator.cpp:41
Class for compute crc16.
Definition: erpc_crc16.h:29
RequestContext * m_request
Definition: erpc_transport_arbitrator.h:137
virtual void setCrc16(Crc16 *crcImpl) override
This functions sets the CRC-16 implementation.
Definition: erpc_transport_arbitrator.cpp:48
void setCodec(Codec *codec)
This function set codec.
Definition: erpc_transport_arbitrator.h:68
PendingClientInfo * m_clientList
Active client receive requests.
Definition: erpc_transport_arbitrator.h:157
Codec * m_codec
Codec used to read incoming message headers.
Definition: erpc_transport_arbitrator.h:155
Mutex m_clientListMutex
Mutex guarding the client active and free lists.
Definition: erpc_transport_arbitrator.h:159
virtual erpc_status_t receive(MessageBuffer *message) override
Prototype for receiving message.
Definition: erpc_transport_arbitrator.cpp:62
void setSharedTransport(Transport *shared)
This function set shared client/server transport.
Definition: erpc_transport_arbitrator.h:61
Semaphore m_sem
Definition: erpc_transport_arbitrator.h:138
TransportArbitrator(void)
Constructor.
Definition: erpc_transport_arbitrator.cpp:31
virtual erpc_status_t send(MessageBuffer *message) override
Prototype for send message.
Definition: erpc_transport_arbitrator.cpp:143
uintptr_t client_token_t
Represents a single client's receive request.
Definition: erpc_transport_arbitrator.h:44
Mutex.
Definition: erpc_threading.h:338
virtual bool hasMessage(void) override
Check if the underlying shared transport has a message.
Definition: erpc_transport_arbitrator.cpp:55
Simple semaphore class.
Definition: erpc_threading.h:445
Encapsulates all information about a request.
Definition: erpc_client_manager.h:212