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
|
/*
* Copyright (c) 2017-2019 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 listenerSet.h
* @brief A listener set is unique on (EncapType, localAddress)
*
* Keeps track of all the running listeners. The set is unique on the
* encapsulation type and the local address. For example, with TCP
* encapsulation and local address 127.0.0.1 or Ethernet encapsulation and MAC
* address 00:11:22:33:44:55.
*
* NOTE: This does not allow multiple EtherType on the same interface because
* the Address for a LINK address does not include an EtherType.
*
*/
#ifndef listenerSet_h
#define listenerSet_h
#include <src/io/listener.h>
struct listener_set;
typedef struct listener_set ListenerSet;
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
ListenerSet *listenerSet_Create(void);
/**
* <#One Line Description#>
*
* <#Paragraphs Of Explanation#>
*
* @param [<#in out in,out#>] <#name#> <#description#>
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
void listenerSet_Destroy(ListenerSet **setPtr);
/**
* @function listenerSet_Add
* @abstract Adds the listener to the set
* @discussion
* Unique set based on pair (EncapType, localAddress).
* Takes ownership of the ops memory if added.
*
* @param <#param1#>
* @return true if added, false if not
*/
bool listenerSet_Add(ListenerSet *set, ListenerOps *ops);
/**
* The number of listeners in the set
*
* <#Paragraphs Of Explanation#>
*
* @param [in] set An allocated listener set
*
* @retval <#value#> <#explanation#>
*
* Example:
* @code
* <#example#>
* @endcode
*/
size_t listenerSet_Length(const ListenerSet *set);
size_t listenerSet_Length(const ListenerSet *set);
/**
* Returns the listener at the given index
*
* <#Paragraphs Of Explanation#>
*
* @param [in] set An allocated listener set
* @param [in] index The index position (0 <= index < listenerSet_Lenght)
*
* @retval non-null The listener at index
* @retval null An error
*
* Example:
* @code
* <#example#>
* @endcode
*/
ListenerOps *listenerSet_Get(const ListenerSet *set, size_t index);
/**
* Looks up a listener by its key (EncapType, LocalAddress)
*
* <#Paragraphs Of Explanation#>
*
* @param [in] set An allocated listener set
* @param [in] encapType the listener type
* @param [in] localAddress The local bind address (e.g. MAC address or TCP
* socket)
*
* @retval non-null The listener matching the query
* @retval null Does not exist
*
* Example:
* @code
*
* @endcode
*/
ListenerOps *listenerSet_Find(const ListenerSet *set, EncapType encapType,
const Address *localAddress);
#endif
|
