summaryrefslogtreecommitdiffstats
path: root/src/jabber_whiteboard/callbacks.h
blob: 7a41a40107f9fa7f780aa4efc1e601b26f5680a5 (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
/**
 * Whiteboard session manager
 * Message dispatch devices and timeout triggers
 *
 * Authors:
 * David Yip <yipdw@rose-hulman.edu>
 *
 * Copyright (c) 2005 Authors
 *
 * Released under GNU GPL, read the file 'COPYING' for more information
 */

#ifndef __WHITEBOARD_CALLBACKS_H__
#define __WHITEBOARD_CALLBACKS_H__

#include <glibmm.h>

namespace Inkscape {

namespace Whiteboard {

class SessionManager;
class SessionData;

/**
 * Callback methods used in timers to dispatch MessageNodes from message queues.
 */
class Callbacks {
public:
	/**
	 * Constructor.
	 *
	 * \param sm The SessionManager to associate with.
	 */
	Callbacks(SessionManager* sm);
	~Callbacks();

	/**
	 * Dispatch a message from the send queue to the associated SessionManager object.
	 *
	 * The SessionManager object handles the task of actually sending out a Jabber message.
	 *
	 * \see Inkscape::Whiteboard::SessionManager::sendMessage
	 * \return Whether or not this callback should be called again by the timer routine.
	 */
	bool dispatchSendQueue();

	/**
	 * Dispatch a message from the receive queue to the associated SessionManager object.
	 *
	 * The SessionManager object handles the task of actually processing a Jabber message.
	 *
	 * \see Inkscape::Whiteboard::SessionManager::receiveChange
	 * \return Whether or not this callback should be called again by the timer routine.
	 */
	bool dispatchReceiveQueue();

private:
	SessionManager* _sm;
	SessionData* _sd;
};


}

}

#endif

/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :