summaryrefslogtreecommitdiff
path: root/gio/src/socketlistener.hg
blob: ec3690025d0f4a584798535b3cb7571074bb4261 (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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/* Copyright (C) 2010 Jonathon Jongsma
 *
 * 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.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <glibmm/object.h>
#include <giomm/enums.h>
#include <giomm/socket.h>
#include <giomm/socketconnection.h>
#include <giomm/asyncresult.h>

_DEFS(giomm,gio)
_PINCLUDE(glibmm/private/object_p.h)

namespace Gio
{

/**
 * Helper for accepting network client connections
 *
 * @see ThreadedSocketService, SocketService.
 *
 * A SocketListener is an object that keeps track of a set
 * of server sockets and helps you accept sockets from any of the
 * socket, either sync or async.
 *
 * If you want to implement a network server, also look at SocketService
 * and ThreadedSocketService which are subclass of SocketListener
 * that makes this even easier.
 *
 * @newin{2,24}
 * @ingroup NetworkIO
 */
class GIOMM_API SocketListener : public Glib::Object
{
  _CLASS_GOBJECT(SocketListener, GSocketListener, G_SOCKET_LISTENER, Glib::Object, GObject, , , GIOMM_API)

protected:
  _CTOR_DEFAULT

public:
  _WRAP_CREATE()

  _WRAP_METHOD(void set_backlog(int listen_backlog), g_socket_listener_set_backlog)

  _WRAP_METHOD(bool add_socket(const Glib::RefPtr<Socket>& socket, const Glib::RefPtr<Glib::Object>& source_object), g_socket_listener_add_socket, errthrow)

 //TODO: The use of WRAP_METHOD_DOCS_ONLY here is almost certainly not good enough.
 //Check the HTML actually outputed and probably hand-code them as for Gio::File.

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_add_socket)
  bool add_socket(const Glib::RefPtr<Socket>& socket);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_add_address)
bool add_address(const Glib::RefPtr<SocketAddress>& address, Socket::Type type, Socket::Protocol protocol, const Glib::RefPtr<Glib::Object>& source_object, Glib::RefPtr<SocketAddress>& effective_address);
  _IGNORE(g_socket_listener_add_address)

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_add_address)
  bool add_address(const Glib::RefPtr<SocketAddress>& address, Socket::Type type, Socket::Protocol protocol, Glib::RefPtr<SocketAddress>& effective_address);

  _WRAP_METHOD(bool add_inet_port(guint16 port, const Glib::RefPtr<Glib::Object>& source_object), g_socket_listener_add_inet_port, errthrow)

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_add_inet_port)
bool add_inet_port(guint16 port);

  _WRAP_METHOD(guint16 add_any_inet_port(const Glib::RefPtr<Glib::Object>& source_object), g_socket_listener_add_any_inet_port, errthrow)

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_add_any_inet_port)
  guint16 add_any_inet_port();

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket)
Glib::RefPtr<Socket> accept_socket(Glib::RefPtr<Glib::Object>& source_object, const Glib::RefPtr<Cancellable>& cancellable);
  _IGNORE(g_socket_listener_accept_socket)

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket)
  Glib::RefPtr<Socket> accept_socket(Glib::RefPtr<Glib::Object>& source_object);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket)
  Glib::RefPtr<Socket> accept_socket(const Glib::RefPtr<Cancellable>& cancellable);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket)
  Glib::RefPtr<Socket> accept_socket();


  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket_async)
  void accept_socket_async(const Glib::RefPtr<Cancellable>& cancellable, const SlotAsyncReady& slot);
  _IGNORE(g_socket_listener_accept_socket_async)

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket_async)
  void accept_socket_async(const SlotAsyncReady& slot);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket_finish)
  Glib::RefPtr<Socket> accept_socket_finish(const Glib::RefPtr<AsyncResult>& result, Glib::RefPtr<Glib::Object>& source_object);
  _IGNORE(g_socket_listener_accept_socket_finish)

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_socket_finish)
  Glib::RefPtr<Socket> accept_socket_finish(const Glib::RefPtr<AsyncResult>& result);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept)
  Glib::RefPtr<SocketConnection> accept(Glib::RefPtr<Object>& source_object, const Glib::RefPtr<Cancellable>& cancellable);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept)
  Glib::RefPtr<SocketConnection> accept(Glib::RefPtr<Object>& source_object);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept)
  Glib::RefPtr<SocketConnection> accept(const Glib::RefPtr<Cancellable>& cancellable);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept)
  Glib::RefPtr<SocketConnection> accept();
  _IGNORE(g_socket_listener_accept)

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_async)
  void accept_async(const SlotAsyncReady& slot);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_async)
  void accept_async(const Glib::RefPtr<Cancellable>& cancellable, const SlotAsyncReady& slot);
  _IGNORE(g_socket_listener_accept_async)

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_finish)
  Glib::RefPtr<SocketConnection> accept_finish(const Glib::RefPtr<AsyncResult>& result, Glib::RefPtr<Glib::Object>& source_object);

  _WRAP_METHOD_DOCS_ONLY(g_socket_listener_accept_finish)
  Glib::RefPtr<SocketConnection> accept_finish(const Glib::RefPtr<AsyncResult>& result);

  _WRAP_METHOD(void close(), g_socket_listener_close)

  _WRAP_PROPERTY("listen-backlog", int)
};

} // namespace Gio