Fawkes API  Fawkes Development Version
hub.h
1 
2 /***************************************************************************
3  * hub.h - Fawkes network hub
4  *
5  * Created: Mon May 07 19:06:30 2007
6  * Copyright 2006-2007 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version. A runtime exception applies to
14  * this software (see LICENSE.GPL_WRE file mentioned below for details).
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Library General Public License for more details.
20  *
21  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22  */
23 
24 #ifndef __NETCOMM_FAWKES_HUB_H_
25 #define __NETCOMM_FAWKES_HUB_H_
26 
27 namespace fawkes {
28 
29 class FawkesNetworkMessage;
30 class FawkesNetworkHandler;
31 class FawkesNetworkMessageContent;
32 
34 {
35  public:
36  virtual ~FawkesNetworkHub();
37 
38  virtual void broadcast(FawkesNetworkMessage *msg) = 0;
39 
40  virtual void broadcast(unsigned short int component_id,
41  unsigned short int msg_id,
42  void *payload, unsigned int payload_size) = 0;
43 
44  virtual void broadcast(unsigned short int component_id,
45  unsigned short int msg_id) = 0;
46 
47 
48  virtual void send(FawkesNetworkMessage *msg) = 0;
49 
50  virtual void send(unsigned int to_clid,
51  unsigned short int component_id,
52  unsigned short int msg_id) = 0;
53 
54  virtual void send(unsigned int to_clid,
55  unsigned short int component_id,
56  unsigned short int msg_id,
57  void *payload, unsigned int payload_size) = 0;
58 
59  virtual void send(unsigned int to_clid,
60  unsigned short int component_id,
61  unsigned short int msg_id,
62  FawkesNetworkMessageContent *content) = 0;
63 
64  virtual void add_handler(FawkesNetworkHandler *handler) = 0;
65  virtual void remove_handler(FawkesNetworkHandler *handler) = 0;
66 
67 
68  virtual void force_send() = 0;
69 
70 };
71 
72 } // end namespace fawkes
73 
74 #endif
Fawkes library namespace.
virtual void add_handler(FawkesNetworkHandler *handler)=0
Add a message handler.
Representation of a message that is sent over the network.
Definition: message.h:75
Fawkes network message content.
virtual ~FawkesNetworkHub()
Virtual empty destructor.
Definition: hub.cpp:119
Fawkes Network Hub.
Definition: hub.h:33
virtual void send(FawkesNetworkMessage *msg)=0
Method to send a message to a specific client.
virtual void force_send()=0
Force sending of all pending messages.
Network handler abstract base class.
Definition: handler.h:31
virtual void broadcast(FawkesNetworkMessage *msg)=0
Method to broadcast a message to all connected clients.
virtual void remove_handler(FawkesNetworkHandler *handler)=0
Remove a message handler.