blob: 3ad89b4bc20916685399c8618637aafe53f0ae9e (
plain) (
blame)
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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include <memory>
#include <vector>
namespace fnet {
struct ChannelMap;
}
class FNET_Channel;
class FNET_ControlPacket;
/**
* This class handles registration/deregistration and lookup of
* Channel objects. Note that locking must be done by the users of
* this class in order to obtain thread safety. This class is used by
* the @ref FNET_Connection class to keep track of channels. NOTE:
* this class is not intended for direct use; use at own risk.
**/
class FNET_ChannelLookup
{
private:
std::unique_ptr<fnet::ChannelMap> _map;
FNET_ChannelLookup(const FNET_ChannelLookup &);
FNET_ChannelLookup &operator=(const FNET_ChannelLookup &);
public:
/**
* Construct a channel lookup.
*
* @param hashSize Size of hash table used for lookup. Currently the
* hash size may not be modified during the lifetime of a
* ChannelLookup object.
**/
FNET_ChannelLookup(uint32_t hashSize = 16);
/**
* Delete hash table. NOTE: The hash table must be empty when this
* method is called.
**/
~FNET_ChannelLookup();
/**
* Register a channel. If you register several channels with the
* same ID, only the last registered channel will be availible by
* calling the Lookup method.
*
* @param channel the channel you want to register.
**/
void Register(FNET_Channel *channel);
/**
* Find a channel given the channel ID.
*
* @return channel with correct id or nullptr if not found.
* @param id channel ID of the channel you are looking for.
**/
FNET_Channel *Lookup(uint32_t id);
/**
* Broadcast a control packet to all channels registered with this
* channel lookup. The given control packet will be sent on all
* channels currently registered. The control packet is sent
* sequentially (using the calling thread) to all channels in no
* special order. When receiving a packet, the packet handler
* registered for a channel may use the return code of the
* HandlePacket method to indicate that the channel should be kept
* open, closed or even freed. Keeping channels open and closing
* them (unregistering them) is performed internally by this
* method. Freeing channels, however, is left to the caller of this
* method. The channels that are to be freed are linked together and
* returned from this method.
*
* @return vector of all channels to be freed.
* @param cpacket the control packet you want to broadcast.
**/
std::vector<std::unique_ptr<FNET_Channel>> Broadcast(FNET_ControlPacket *cpacket);
/**
* Unregister a channel. This method uses both the channel ID and
* the object identity of the parameter to ensure that the correct
* object is unregistered even if there are several channels
* currently registered with the same channel ID.
*
* @return true(ok)/false(not found)
* @param channel the channel you want to unregister.
**/
bool Unregister(FNET_Channel *channel);
};
|
