blob: 799c45e61c162f5cc49390775536563bf59b6617 (
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
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed 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.
*/
/**
* @file rta_ApiConnection.h
* @brief Implementation of the API connection
*
* <#Detailed Description#>
*
*/
#ifndef TransportRTA_rta_ApiConnection_h
#define TransportRTA_rta_ApiConnection_h
struct rta_api_connection;
typedef struct rta_api_connection RtaApiConnection;
#include <ccnx/transport/transport_rta/core/rta_Connection.h>
RtaApiConnection *rtaApiConnection_Create(RtaConnection *connection);
void rtaApiConnection_Destroy(RtaApiConnection **rtaApiConnectionPtr);
/**
* Sends a TransportMessage up to the API
*
* Decapsulates the ccnx message and sends it up to the API. It will destroy the TransportMessage wrapper.
*
* @param [in] apiConnection The API connection to write to
* @param [in] tm The transport message to send
* @param [in] stats The statistics counter to increment on success
*
* @return true Transport message written
* @return false Transport message not written (but still destroyed)
*
* Example:
* @code
* <#example#>
* @endcode
*/
bool rtaApiConnection_SendToApi(RtaApiConnection *apiConnection, TransportMessage *tm, RtaComponentStats *stats);
/**
* Block data flow in the DOWN direction
*
* To block in the DOWN direction, we disable READ events on the API's buffer
*
* @param [in] apiConnection The API Connector's connection state
* @param [in] conn The RTA Connection
*
* Example:
* @code
* <#example#>
* @endcode
*/
void rtaApiConnection_BlockDown(RtaApiConnection *apiConnection);
/**
* Unblock data flow in the DOWN direction
*
* To unblock in the DOWN direction, we enable READ events on the API's buffer
*
* @param [in] apiConnection The API Connector's connection state
* @param [in] conn The RTA Connection
*
* Example:
* @code
* <#example#>
* @endcode
*/
void rtaApiConnection_UnblockDown(RtaApiConnection *apiConnection);
#endif
|
