/usr/include/giomm-2.4/giomm/socketclient.h is in libglibmm-2.4-dev 2.42.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GIOMM_SOCKETCLIENT_H
#define _GIOMM_SOCKETCLIENT_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* 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, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/object.h>
#include <giomm/asyncresult.h>
#include <giomm/cancellable.h>
#include <giomm/socketconnectable.h>
#include <giomm/enums.h>
#include <giomm/socket.h>
#include <giomm/socketconnection.h>
#include <giomm/proxyresolver.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GSocketClient GSocketClient;
typedef struct _GSocketClientClass GSocketClientClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{ class SocketClient_Class; } // namespace Gio
namespace Gio
{
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var SocketClientEvent SOCKET_CLIENT_RESOLVING
* The client is doing a DNS lookup.
*
* @var SocketClientEvent SOCKET_CLIENT_RESOLVED
* The client has completed a DNS lookup.
*
* @var SocketClientEvent SOCKET_CLIENT_CONNECTING
* The client is connecting to a remote host (either a proxy or the destination server).
*
* @var SocketClientEvent SOCKET_CLIENT_CONNECTED
* The client has connected to a remote host.
*
* @var SocketClientEvent SOCKET_CLIENT_PROXY_NEGOTIATING
* The client is negotiating with a proxy to connect to the destination server.
*
* @var SocketClientEvent SOCKET_CLIENT_PROXY_NEGOTIATED
* The client has negotiated with the proxy server.
*
* @var SocketClientEvent SOCKET_CLIENT_TLS_HANDSHAKING
* The client is performing a TLS handshake.
*
* @var SocketClientEvent SOCKET_CLIENT_TLS_HANDSHAKED
* The client has performed a TLS handshake.
*
* @var SocketClientEvent SOCKET_CLIENT_COMPLETE
* The client is done with a particular SocketConnectable.
*
* @enum SocketClientEvent
*
* Describes an event occurring on a SocketClient. See the
* SocketClient::signal_event() signal for more details.
*
* Additional values may be added to this type in the future.
*
* @newin{2,32}
* @ingroup giommEnums
*/
enum SocketClientEvent
{
SOCKET_CLIENT_RESOLVING,
SOCKET_CLIENT_RESOLVED,
SOCKET_CLIENT_CONNECTING,
SOCKET_CLIENT_CONNECTED,
SOCKET_CLIENT_PROXY_NEGOTIATING,
SOCKET_CLIENT_PROXY_NEGOTIATED,
SOCKET_CLIENT_TLS_HANDSHAKING,
SOCKET_CLIENT_TLS_HANDSHAKED,
SOCKET_CLIENT_COMPLETE
};
} // namespace Gio
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gio::SocketClientEvent> : public Glib::Value_Enum<Gio::SocketClientEvent>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
/** Helper for connecting to a network service.
*
* @see SocketConnection, SocketListener
*
* SocketClient is a high-level utility class for connecting to a
* network host using a connection oriented socket type.
*
* You create a SocketClient object, set any options you want, then
* call a sync or async connect operation, which returns a SocketConnection
* subclass on success.
*
* The type of the SocketConnection object returned depends on the type of
* the underlying socket that is in use. For instance, for a TCP/IP connection
* it will be a TcpConnection.
*
* @newin{2,24}
* @ingroup NetworkIO
*/
class SocketClient : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef SocketClient CppObjectType;
typedef SocketClient_Class CppClassType;
typedef GSocketClient BaseObjectType;
typedef GSocketClientClass BaseClassType;
private: friend class SocketClient_Class;
static CppClassType socketclient_class_;
private:
// noncopyable
SocketClient(const SocketClient&);
SocketClient& operator=(const SocketClient&);
protected:
explicit SocketClient(const Glib::ConstructParams& construct_params);
explicit SocketClient(GSocketClient* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~SocketClient();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GSocketClient* gobj() { return reinterpret_cast<GSocketClient*>(gobject_); }
///Provides access to the underlying C GObject.
const GSocketClient* gobj() const { return reinterpret_cast<GSocketClient*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GSocketClient* gobj_copy();
private:
protected:
SocketClient();
public:
static Glib::RefPtr<SocketClient> create();
/** Gets the socket family of the socket client.
*
* See g_socket_client_set_family() for details.
*
* @newin{2,22}
*
* @return A SocketFamily.
*/
SocketFamily get_family() const;
/** Sets the socket family of the socket client.
* If this is set to something other than SOCKET_FAMILY_INVALID
* then the sockets created by this object will be of the specified
* family.
*
* This might be useful for instance if you want to force the local
* connection to be an ipv4 socket, even though the address might
* be an ipv6 mapped to ipv4 address.
*
* @newin{2,22}
*
* @param family A SocketFamily.
*/
void set_family(SocketFamily family);
/** Gets the socket type of the socket client.
*
* See g_socket_client_set_socket_type() for details.
*
* @newin{2,22}
*
* @return A SocketFamily.
*/
SocketType get_socket_type() const;
/** Sets the socket type of the socket client.
* The sockets created by this object will be of the specified
* type.
*
* It doesn't make sense to specify a type of SOCKET_TYPE_DATAGRAM,
* as GSocketClient is used for connection oriented services.
*
* @newin{2,22}
*
* @param type A SocketType.
*/
void set_socket_type(SocketType type);
/** Gets the protocol name type of the socket client.
*
* See g_socket_client_set_protocol() for details.
*
* @newin{2,22}
*
* @return A SocketProtocol.
*/
SocketProtocol get_protocol() const;
/** Sets the protocol of the socket client.
* The sockets created by this object will use of the specified
* protocol.
*
* If @a protocol is %0 that means to use the default
* protocol for the socket family and type.
*
* @newin{2,22}
*
* @param protocol A SocketProtocol.
*/
void set_protocol(SocketProtocol protocol);
/** Gets the local address of the socket client.
*
* See g_socket_client_set_local_address() for details.
*
* @newin{2,22}
*
* @return A SocketAddress or <tt>0</tt>. Do not free.
*/
Glib::RefPtr<SocketAddress> get_local_address();
/** Gets the local address of the socket client.
*
* See g_socket_client_set_local_address() for details.
*
* @newin{2,22}
*
* @return A SocketAddress or <tt>0</tt>. Do not free.
*/
Glib::RefPtr<const SocketAddress> get_local_address() const;
/** Sets the local address of the socket client.
* The sockets created by this object will bound to the
* specified address (if not <tt>0</tt>) before connecting.
*
* This is useful if you want to ensure that the local
* side of the connection is on a specific port, or on
* a specific interface.
*
* @newin{2,22}
*
* @param address A SocketAddress, or <tt>0</tt>.
*/
void set_local_address(const Glib::RefPtr<SocketAddress>& address);
/** Tries to resolve the @a connectable and make a network connection to it.
*
* Upon a successful connection, a new SocketConnection is constructed
* and returned. The caller owns this new object and must drop their
* reference to it when finished with it.
*
* The type of the SocketConnection object returned depends on the type of
* the underlying socket that is used. For instance, for a TCP/IP connection
* it will be a TcpConnection.
*
* The socket created will be the same family as the address that the
* @a connectable resolves to, unless family is set with g_socket_client_set_family()
* or indirectly via g_socket_client_set_local_address(). The socket type
* defaults to SOCKET_TYPE_STREAM but can be set with
* g_socket_client_set_socket_type().
*
* If a local address is specified with g_socket_client_set_local_address() the
* socket will be bound to this address before connecting.
*
* @newin{2,22}
*
* @param connectable A SocketConnectable specifying the remote address.
* @param cancellable Optional Cancellable object, <tt>0</tt> to ignore.
* @return A SocketConnection on success, <tt>0</tt> on error.
*/
Glib::RefPtr<SocketConnection> connect(const Glib::RefPtr<SocketConnectable>& connectable, const Glib::RefPtr<Cancellable>& cancellable);
/// A connect() convenience overload.
Glib::RefPtr<SocketConnection> connect(const Glib::RefPtr<SocketConnectable>& connectable);
/** This is a helper function for g_socket_client_connect().
*
* Attempts to create a TCP connection to the named host.
*
* @a host_and_port may be in any of a number of recognized formats; an IPv6
* address, an IPv4 address, or a domain name (in which case a DNS
* lookup is performed). Quoting with [] is supported for all address
* types. A port override may be specified in the usual way with a
* colon. Ports may be given as decimal numbers or symbolic names (in
* which case an /etc/services lookup is performed).
*
* If no port override is given in @a host_and_port then @a default_port will be
* used as the port number to connect to.
*
* In general, @a host_and_port is expected to be provided by the user (allowing
* them to give the hostname, and a port override if necessary) and
* @a default_port is expected to be provided by the application.
*
* In the case that an IP address is given, a single connection
* attempt is made. In the case that a name is given, multiple
* connection attempts may be made, in turn and according to the
* number of address records in DNS, until a connection succeeds.
*
* Upon a successful connection, a new SocketConnection is constructed
* and returned. The caller owns this new object and must drop their
* reference to it when finished with it.
*
* In the event of any failure (DNS error, service not found, no hosts
* connectable) <tt>0</tt> is returned and @a error (if non-<tt>0</tt>) is set
* accordingly.
*
* @newin{2,22}
*
* @param host_and_port The name and optionally port of the host to connect to.
* @param default_port The default port to connect to.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @return A SocketConnection on success, <tt>0</tt> on error.
*/
Glib::RefPtr<SocketConnection> connect_to_host(const Glib::ustring& host_and_port, guint16 default_port, const Glib::RefPtr<Cancellable>& cancellable);
/// A connect_to_host() convenience overload.
Glib::RefPtr<SocketConnection> connect_to_host(const Glib::ustring& host_and_port, guint16 default_port);
/** Attempts to create a TCP connection to a service.
*
* This call looks up the SRV record for @a service at @a domain for the
* "tcp" protocol. It then attempts to connect, in turn, to each of
* the hosts providing the service until either a connection succeeds
* or there are no hosts remaining.
*
* Upon a successful connection, a new SocketConnection is constructed
* and returned. The caller owns this new object and must drop their
* reference to it when finished with it.
*
* In the event of any failure (DNS error, service not found, no hosts
* connectable) <tt>0</tt> is returned and @a error (if non-<tt>0</tt>) is set
* accordingly.
*
* @param domain A domain name.
* @param service The name of the service to connect to.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @return A SocketConnection if successful, or <tt>0</tt> on error.
*/
Glib::RefPtr<SocketConnection> connect_to_service(const Glib::ustring& domain, const Glib::ustring& service, const Glib::RefPtr<Cancellable>& cancellable);
/// A connect_to_service() convenience overload.
Glib::RefPtr<SocketConnection> connect_to_service(const Glib::ustring& domain, const Glib::ustring& service);
/** This is a helper function for g_socket_client_connect().
*
* Attempts to create a TCP connection with a network URI.
*
* @a uri may be any valid URI containing an "authority" (hostname/port)
* component. If a port is not specified in the URI, @a default_port
* will be used. TLS will be negotiated if SocketClient::property_tls() is <tt>true</tt>.
* (SocketClient does not know to automatically assume TLS for
* certain URI schemes.)
*
* Using this rather than g_socket_client_connect() or
* g_socket_client_connect_to_host() allows SocketClient to
* determine when to use application-specific proxy protocols.
*
* Upon a successful connection, a new SocketConnection is constructed
* and returned. The caller owns this new object and must drop their
* reference to it when finished with it.
*
* In the event of any failure (DNS error, service not found, no hosts
* connectable) <tt>0</tt> is returned and @a error (if non-<tt>0</tt>) is set
* accordingly.
*
* @newin{2,26}
*
* @param uri A network URI.
* @param default_port The default port to connect to.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @return A SocketConnection on success, <tt>0</tt> on error.
*/
Glib::RefPtr<SocketConnection> connect_to_uri(const Glib::ustring& uri, guint16 default_port, const Glib::RefPtr<Cancellable>& cancellable);
/// A connect_to_uri() convenience overload.
Glib::RefPtr<SocketConnection> connect_to_uri(const Glib::ustring& uri, guint16 default_port);
/** This is the asynchronous version of g_socket_client_connect().
*
* When the operation is finished @a slot will be
* called. You can then call g_socket_client_connect_finish() to get
* the result of the operation.
*
* @newin{2,22}
*
* @param connectable A SocketConnectable specifying the remote address.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @param slot A SlotAsyncReady.
* @param user_data User data for the callback.
*/
void connect_async(const Glib::RefPtr<SocketConnectable>& connectable, const Glib::RefPtr<Cancellable>& cancellable, const SlotAsyncReady& slot);
/** This is the asynchronous version of connect().
* When the operation is finished @a slot will be called. You can then call finish() to get the result of the operation.
*
* @param connectable A SocketConnectable specifying the remote address.
* @param slot A callback slot to call after the operation completes.
*/
void connect_async(const Glib::RefPtr<SocketConnectable>& connectable, const SlotAsyncReady& slot);
/** Finishes an async connect operation. See g_socket_client_connect_async()
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return A SocketConnection on success, <tt>0</tt> on error.
*/
Glib::RefPtr<SocketConnection> connect_finish(const Glib::RefPtr<AsyncResult>& result);
/** This is the asynchronous version of g_socket_client_connect_to_host().
*
* When the operation is finished @a slot will be
* called. You can then call g_socket_client_connect_to_host_finish() to get
* the result of the operation.
*
* @newin{2,22}
*
* @param host_and_port The name and optionally the port of the host to connect to.
* @param default_port The default port to connect to.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @param slot A SlotAsyncReady.
* @param user_data User data for the callback.
*/
void connect_to_host_async(const Glib::ustring& host_and_port, guint16 default_port, const Glib::RefPtr<Cancellable>& cancellable, const SlotAsyncReady& slot);
/** This is the asynchronous version of connect_to_host().
* When the operation is finished @a slot will be called. You can then call connect_to_host_finish() to get the result of the operation.
*
* @param host_and_port The name and optionally the port of the host to connect to.
* @param default_port The default port to connect to.
* @param slot A callback slot to call after the opration completes.
*/
void connect_to_host_async(const Glib::ustring& host_and_port, guint16 default_port, const SlotAsyncReady& slot);
/** Finishes an async connect operation. See g_socket_client_connect_to_host_async()
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return A SocketConnection on success, <tt>0</tt> on error.
*/
Glib::RefPtr<SocketConnection> connect_to_host_finish(const Glib::RefPtr<AsyncResult>& result);
/** This is the asynchronous version of
* g_socket_client_connect_to_service().
*
* @newin{2,22}
*
* @param domain A domain name.
* @param service The name of the service to connect to.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @param slot A SlotAsyncReady.
* @param user_data User data for the callback.
*/
void connect_to_service_async(const Glib::ustring& domain, const Glib::ustring& service, const Glib::RefPtr<Cancellable>& cancellable, const SlotAsyncReady& slot);
/** This is the asynchronous version of connect_to_service().
*
* @param domain A domain name.
* @param service The name of the service to connect to
* @param slot A callback slot to call after the opration completes.
*/
void connect_to_service_async(const Glib::ustring& domain, const Glib::ustring& service, const SlotAsyncReady& slot);
/** Finishes an async connect operation. See g_socket_client_connect_to_service_async()
*
* @newin{2,22}
*
* @param result A AsyncResult.
* @return A SocketConnection on success, <tt>0</tt> on error.
*/
Glib::RefPtr<SocketConnection> connect_to_service_finish(const Glib::RefPtr<AsyncResult>& result);
/** This is the asynchronous version of g_socket_client_connect_to_uri().
*
* When the operation is finished @a slot will be
* called. You can then call g_socket_client_connect_to_uri_finish() to get
* the result of the operation.
*
* @newin{2,26}
*
* @param uri A network uri.
* @param default_port The default port to connect to.
* @param cancellable A Cancellable, or <tt>0</tt>.
* @param slot A SlotAsyncReady.
* @param user_data User data for the callback.
*/
void connect_to_uri_async(const Glib::ustring& uri, guint16 default_port, const Glib::RefPtr<Cancellable>& cancellable, const SlotAsyncReady& slot);
/** This is the asynchronous version of connect_to_uri().
*
* @param uri A network URI.
* @param default_port The default port to connect to.
* @param slot A callback slot to call after the opration completes.
*/
void connect_to_uri_async(const Glib::ustring& uri, guint16 default_port, const SlotAsyncReady& slot);
/** Finishes an async connect operation. See g_socket_client_connect_to_uri_async()
*
* @newin{2,26}
*
* @param result A AsyncResult.
* @return A SocketConnection on success, <tt>0</tt> on error.
*/
Glib::RefPtr<SocketConnection> connect_to_uri_finish(const Glib::RefPtr<AsyncResult>& result);
/** Gets the proxy enable state; see g_socket_client_set_enable_proxy()
*
* @newin{2,26}
*
* @return Whether proxying is enabled.
*/
bool get_enable_proxy() const;
/** Sets whether or not @a client attempts to make connections via a
* proxy server. When enabled (the default), SocketClient will use a
* ProxyResolver to determine if a proxy protocol such as SOCKS is
* needed, and automatically do the necessary proxy negotiation.
*
* See also g_socket_client_set_proxy_resolver().
*
* @newin{2,26}
*
* @param enable Whether to enable proxies.
*/
void set_enable_proxy(bool enable);
/** Gets whether @a client creates TLS connections. See
* g_socket_client_set_tls() for details.
*
* @newin{2,28}
*
* @return Whether @a client uses TLS.
*/
bool get_tls() const;
/** Sets whether @a client creates TLS (aka SSL) connections. If @a tls is
* <tt>true</tt>, @a client will wrap its connections in a TlsClientConnection
* and perform a TLS handshake when connecting.
*
* Note that since SocketClient must return a SocketConnection,
* but TlsClientConnection is not a SocketConnection, this
* actually wraps the resulting TlsClientConnection in a
* TcpWrapperConnection when returning it. You can use
* g_tcp_wrapper_connection_get_base_io_stream() on the return value
* to extract the TlsClientConnection.
*
* If you need to modify the behavior of the TLS handshake (eg, by
* setting a client-side certificate to use, or connecting to the
* TlsConnection::signal_accept_certificate() signal), you can connect to
* @a client's SocketClient::signal_event() signal and wait for it to be
* emitted with SOCKET_CLIENT_TLS_HANDSHAKING, which will give you
* a chance to see the TlsClientConnection before the handshake
* starts.
*
* @newin{2,28}
*
* @param tls Whether to use TLS.
*/
void set_tls(bool tls = true);
/** Gets the TLS validation flags used creating TLS connections via
* @a client.
*
* @newin{2,28}
*
* @return The TLS validation flags.
*/
TlsCertificateFlags get_tls_validation_flags() const;
/** Sets the TLS validation flags used when creating TLS connections
* via @a client. The default value is TLS_CERTIFICATE_VALIDATE_ALL.
*
* @newin{2,28}
*
* @param flags The validation flags.
*/
void set_tls_validation_flags(TlsCertificateFlags flags);
/** Gets the ProxyResolver being used by @a client. Normally, this will
* be the resolver returned by g_proxy_resolver_get_default(), but you
* can override it with g_socket_client_set_proxy_resolver().
*
* @newin{2,36}
*
* @return The ProxyResolver being used by
* @a client.
*/
Glib::RefPtr<ProxyResolver> get_proxy_resolver();
/** Gets the ProxyResolver being used by @a client. Normally, this will
* be the resolver returned by g_proxy_resolver_get_default(), but you
* can override it with g_socket_client_set_proxy_resolver().
*
* @newin{2,36}
*
* @return The ProxyResolver being used by
* @a client.
*/
Glib::RefPtr<const ProxyResolver> get_proxy_resolver() const;
/** Overrides the ProxyResolver used by @a client. You can call this if
* you want to use specific proxies, rather than using the system
* default proxy settings.
*
* Note that whether or not the proxy resolver is actually used
* depends on the setting of SocketClient::property_enable_proxy(), which is not
* changed by this function (but which is <tt>true</tt> by default)
*
* @newin{2,36}
*
* @param proxy_resolver A ProxyResolver, or <tt>0</tt> for the
* default.
*/
void set_proxy_resolver(const Glib::RefPtr<ProxyResolver>& proxy_resolver);
/** Gets the I/O timeout time for sockets created by @a client.
*
* See g_socket_client_set_timeout() for details.
*
* @newin{2,26}
*
* @return The timeout in seconds.
*/
guint get_timeout() const;
/** Sets the I/O timeout for sockets created by @a client. @a timeout is a
* time in seconds, or 0 for no timeout (the default).
*
* The timeout value affects the initial connection attempt as well,
* so setting this may cause calls to g_socket_client_connect(), etc,
* to fail with IO_ERROR_TIMED_OUT.
*
* @newin{2,26}
*
* @param timeout The timeout.
*/
void set_timeout(guint timeout);
/** Enable proxy protocols to be handled by the application. When the
* indicated proxy protocol is returned by the ProxyResolver,
* SocketClient will consider this protocol as supported but will
* not try to find a Proxy instance to handle handshaking. The
* application must check for this case by calling
* g_socket_connection_get_remote_address() on the returned
* SocketConnection, and seeing if it's a ProxyAddress of the
* appropriate type, to determine whether or not it needs to handle
* the proxy handshaking itself.
*
* This should be used for proxy protocols that are dialects of
* another protocol such as HTTP proxy. It also allows cohabitation of
* proxy protocols that are reused between protocols. A good example
* is HTTP. It can be used to proxy HTTP, FTP and Gopher and can also
* be use as generic socket proxy through the HTTP CONNECT method.
*
* When the proxy is detected as being an application proxy, TLS handshake
* will be skipped. This is required to let the application do the proxy
* specific handshake.
*
* @param protocol The proxy protocol.
*/
void add_application_proxy(const Glib::ustring& protocol);
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The sockets address family to use for socket construction.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< SocketFamily > property_family() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The sockets address family to use for socket construction.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< SocketFamily > property_family() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The local address constructed sockets will be bound to.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<SocketAddress> > property_local_address() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The local address constructed sockets will be bound to.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<SocketAddress> > property_local_address() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The protocol to use for socket construction, or 0 for default.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< SocketProtocol > property_protocol() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The protocol to use for socket construction, or 0 for default.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< SocketProtocol > property_protocol() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The sockets type to use for socket construction.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< SocketType > property_type() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The sockets type to use for socket construction.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< SocketType > property_type() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The I/O timeout for sockets, or 0 for none.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< guint > property_timeout() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The I/O timeout for sockets, or 0 for none.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< guint > property_timeout() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Enable proxy support.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_enable_proxy() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Enable proxy support.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_enable_proxy() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether to create TLS connections.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_tls() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** Whether to create TLS connections.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_tls() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** TLS validation flags to use.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< TlsCertificateFlags > property_tls_validation_flags() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** TLS validation flags to use.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< TlsCertificateFlags > property_tls_validation_flags() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The proxy resolver to use.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< Glib::RefPtr<ProxyResolver> > property_proxy_resolver() ;
#endif //#GLIBMM_PROPERTIES_ENABLED
#ifdef GLIBMM_PROPERTIES_ENABLED
/** The proxy resolver to use.
*
* You rarely need to use properties because there are get_ and set_ methods for almost all of them.
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<ProxyResolver> > property_proxy_resolver() const;
#endif //#GLIBMM_PROPERTIES_ENABLED
/**
* @par Slot Prototype:
* <tt>void on_my_%event(SocketClientEvent event, const Glib::RefPtr<SocketConnectable>& connectable, const Glib::RefPtr<IOStream>& connection)</tt>
*
* Emitted when @a client's activity on @a connectable changes state.
* Among other things, this can be used to provide progress
* information about a network connection in the UI. The meanings of
* the different @a event values are as follows:
*
* - SOCKET_CLIENT_RESOLVING: @a client is about to look up @a connectable
* in DNS. @a connection will be <tt>0</tt>.
*
* - SOCKET_CLIENT_RESOLVED: @a client has successfully resolved
* @a connectable in DNS. @a connection will be <tt>0</tt>.
*
* - SOCKET_CLIENT_CONNECTING: @a client is about to make a connection
* to a remote host; either a proxy server or the destination server
* itself. @a connection is the SocketConnection, which is not yet
* connected. Since GLib 2.40, you can access the remote
* address via g_socket_connection_get_remote_address().
*
* - SOCKET_CLIENT_CONNECTED: @a client has successfully connected
* to a remote host. @a connection is the connected SocketConnection.
*
* - SOCKET_CLIENT_PROXY_NEGOTIATING: @a client is about to negotiate
* with a proxy to get it to connect to @a connectable. @a connection is
* the SocketConnection to the proxy server.
*
* - SOCKET_CLIENT_PROXY_NEGOTIATED: @a client has negotiated a
* connection to @a connectable through a proxy server. @a connection is
* the stream returned from g_proxy_connect(), which may or may not
* be a SocketConnection.
*
* - SOCKET_CLIENT_TLS_HANDSHAKING: @a client is about to begin a TLS
* handshake. @a connection is a TlsClientConnection.
*
* - SOCKET_CLIENT_TLS_HANDSHAKED: @a client has successfully completed
* the TLS handshake. @a connection is a TlsClientConnection.
*
* - SOCKET_CLIENT_COMPLETE: @a client has either successfully connected
* to @a connectable (in which case @a connection is the SocketConnection
* that it will be returning to the caller) or has failed (in which
* case @a connection is <tt>0</tt> and the client is about to return an error).
*
* Each event except SOCKET_CLIENT_COMPLETE may be emitted
* multiple times (or not at all) for a given connectable (in
* particular, if @a client ends up attempting to connect to more than
* one address). However, if @a client emits the SocketClient::signal_event()
* signal at all for a given connectable, that it will always emit
* it with SOCKET_CLIENT_COMPLETE when it is done.
*
* Note that there may be additional SocketClientEvent values in
* the future; unrecognized @a event values should be ignored.
*
* @newin{2,32}
*
* @param event The event that is occurring.
* @param connectable The SocketConnectable that @a event is occurring on.
* @param connection The current representation of the connection.
*/
Glib::SignalProxy3< void,SocketClientEvent,const Glib::RefPtr<SocketConnectable>&,const Glib::RefPtr<IOStream>& > signal_event();
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::SocketClient
*/
Glib::RefPtr<Gio::SocketClient> wrap(GSocketClient* object, bool take_copy = false);
}
#endif /* _GIOMM_SOCKETCLIENT_H */
|