blob: f9adf194003205012fd2843233d86f702e62b1a1 (
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
|
/*
* 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_Framework_Services.h
* @brief Miscellaneous services offered by the Framework for components and connectors
*
* <#Detailed Description#>
*
*/
#ifndef Libccnx_rta_Framework_Services_h
#define Libccnx_rta_Framework_Services_h
#include "rta_Framework.h"
#include <parc/algol/parc_EventScheduler.h>
// ===================================
typedef uint64_t ticks;
#define TICK_CMP(a, b) ((int64_t) a - (int64_t) b)
/**
* <#One Line Description#>
*
* If a component wants to use the event scheduler to manage sockets, it
* can get a reference to the event base to manage those things
*
* @param [in] framework <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
PARCEventScheduler *rtaFramework_GetEventScheduler(RtaFramework *framework);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [in] framework <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
unsigned rtaFramework_GetNextConnectionId(RtaFramework *framework);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [in] framework <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
ticks rtaFramework_GetTicks(RtaFramework *framework);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [in] tick <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
extern uint64_t rtaFramework_TicksToUsec(ticks tick);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [in] usec <#description#>
*
* @return <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*
* @see <#references#>
*/
extern ticks rtaFramework_UsecToTicks(unsigned usec);
#endif // Libccnx_rta_Framework_Services_h
|
