blob: c87ee29892a357b10ed80699c538925464973505 (
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
|
/*
Kopete Oscar Protocol
Oscar Multiple Connection Handling
Copyright (c) 2005 Matt Rogers <mattr@kde.org>
Kopete (c) 2002-2005 by the Kopete developers <kopete-devel@kde.org>
*************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
*************************************************************************
*/
#ifndef CONNECTIONHANDLER_H
#define CONNECTIONHANDLER_H
#include "oscartypes.h"
#include <tqstring.h>
#include <tqpair.h>
class Connection;
typedef TQPair<Oscar::WORD, TQString> ConnectionRoomInfo;
/**
@author Kopete Developers
*/
class ConnectionHandler
{
public:
ConnectionHandler();
~ConnectionHandler();
/**
* Add a connection to the handler so that it can be
* tracked and queried for later.
* @param c The connection to add to the handler
*/
void append( Connection* c );
/**
* Remove a connection from the handler
* @param c The connection object to remove
*/
void remove( Connection* c );
/**
* Remove a connection from the handler
* @param family The SNAC family for the connection to remove
*/
void remove( int family );
/**
* Clear all the connections.
*/
void clear();
/**
* Get the connection for a particular SNAC family. If there is
* more than one connection for a particular family or there is no
* connection, then zero is returned.
* @return A valid connection object for the family or 0
*/
Connection* connectionForFamily( int family ) const;
/**
* Get the default connection. Returns zero when we're handling more than
* one connection.
* @return The only connection object we're tracking or zero if we have
* more than one.
*/
Connection* defaultConnection() const;
/**
* Add chat room information to a connection so that we can track
* connections by chat room
* @param c The connection to add information to
* @param exchange the exchange the chat room is in
* @param room the name of the chat room
*/
void addChatInfoForConnection( Connection* c, Oscar::WORD exchange, const TQString& room );
/**
* Get the connection for a particular room name and exchange number.
* @param exchange the chat room exchange the room is on
* @param room the name of the chat room to find a connection for
* @return a Connection for the chat room or 0L if no connection for that room
*/
Connection* connectionForChatRoom( Oscar::WORD exchange, const TQString& room );
/**
* Get the room name for the chat room based the connection
* @return The name of the chat room that this connection is connected to
* If the connection passed in by @p c is not a chat room connection then
* TQString() is returned.
*/
TQString chatRoomForConnection( Connection* c );
/**
* Get the exchange number for the chat room based on the connection
* @return The exchange of the chat room that this connection is connected
* to. If the connection passed in by @p c is not a chat room connection
* then 0xFFFF is returned
*/
Oscar::WORD exchangeForConnection( Connection* c );
private:
class Private;
Private* d;
};
#endif
|
