gsocketconnectable.h 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. /* GIO - GLib Input, Output and Streaming Library
  2. *
  3. * Copyright (C) 2008 Red Hat, Inc.
  4. *
  5. * SPDX-License-Identifier: LGPL-2.1-or-later
  6. *
  7. * This library is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Lesser General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2.1 of the License, or (at your option) any later version.
  11. *
  12. * This library is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Lesser General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Lesser General
  18. * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19. */
  20. #ifndef __G_SOCKET_CONNECTABLE_H__
  21. #define __G_SOCKET_CONNECTABLE_H__
  22. #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  23. #error "Only <gio/gio.h> can be included directly."
  24. #endif
  25. #include <gio/giotypes.h>
  26. G_BEGIN_DECLS
  27. #define G_TYPE_SOCKET_CONNECTABLE (g_socket_connectable_get_type ())
  28. #define G_SOCKET_CONNECTABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_SOCKET_CONNECTABLE, GSocketConnectable))
  29. #define G_IS_SOCKET_CONNECTABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SOCKET_CONNECTABLE))
  30. #define G_SOCKET_CONNECTABLE_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_SOCKET_CONNECTABLE, GSocketConnectableIface))
  31. typedef struct _GSocketConnectableIface GSocketConnectableIface;
  32. /**
  33. * GSocketConnectableIface:
  34. * @g_iface: The parent interface.
  35. * @enumerate: Creates a #GSocketAddressEnumerator
  36. * @proxy_enumerate: Creates a #GProxyAddressEnumerator
  37. * @to_string: Format the connectable’s address as a string for debugging.
  38. * Implementing this is optional. (Since: 2.48)
  39. *
  40. * Provides an interface for returning a #GSocketAddressEnumerator
  41. * and #GProxyAddressEnumerator
  42. */
  43. struct _GSocketConnectableIface
  44. {
  45. GTypeInterface g_iface;
  46. /* Virtual Table */
  47. GSocketAddressEnumerator * (* enumerate) (GSocketConnectable *connectable);
  48. GSocketAddressEnumerator * (* proxy_enumerate) (GSocketConnectable *connectable);
  49. gchar * (* to_string) (GSocketConnectable *connectable);
  50. };
  51. GIO_AVAILABLE_IN_ALL
  52. GType g_socket_connectable_get_type (void) G_GNUC_CONST;
  53. GIO_AVAILABLE_IN_ALL
  54. GSocketAddressEnumerator *g_socket_connectable_enumerate (GSocketConnectable *connectable);
  55. GIO_AVAILABLE_IN_ALL
  56. GSocketAddressEnumerator *g_socket_connectable_proxy_enumerate (GSocketConnectable *connectable);
  57. GIO_AVAILABLE_IN_2_48
  58. gchar *g_socket_connectable_to_string (GSocketConnectable *connectable);
  59. G_END_DECLS
  60. #endif /* __G_SOCKET_CONNECTABLE_H__ */