// Generated by gmmproc 2.54.1 -- DO NOT MODIFY!
#ifndef _GIOMM_SOCKETCONNECTABLE_H
#define _GIOMM_SOCKETCONNECTABLE_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2007 The giomm Development Team
*
* 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/interface.h>
#include <giomm/socketaddressenumerator.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GSocketConnectableIface GSocketConnectableIface;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GSocketConnectable = struct _GSocketConnectable;
using GSocketConnectableClass = struct _GSocketConnectableClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gio
{ class SocketConnectable_Class; } // namespace Gio
#endif // DOXYGEN_SHOULD_SKIP_THIS
namespace Gio
{
/** Interface for potential socket endpoints
*
* @newin{2,24}
* @ingroup NetworkIO
*/
class SocketConnectable : public Glib::Interface
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
using CppObjectType = SocketConnectable;
using CppClassType = SocketConnectable_Class;
using BaseObjectType = GSocketConnectable;
using BaseClassType = GSocketConnectableIface;
// noncopyable
SocketConnectable(const SocketConnectable&) = delete;
SocketConnectable& operator=(const SocketConnectable&) = delete;
private:
friend class SocketConnectable_Class;
static CppClassType socketconnectable_class_;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
protected:
/**
* You should derive from this class to use it.
*/
SocketConnectable();
#ifndef DOXYGEN_SHOULD_SKIP_THIS
/** Called by constructors of derived classes. Provide the result of
* the Class init() function to ensure that it is properly
* initialized.
*
* @param interface_class The Class object for the derived type.
*/
explicit SocketConnectable(const Glib::Interface_Class& interface_class);
public:
// This is public so that C++ wrapper instances can be
// created for C instances of unwrapped types.
// For instance, if an unexpected C type implements the C interface.
explicit SocketConnectable(GSocketConnectable* castitem);
protected:
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
SocketConnectable(SocketConnectable&& src) noexcept;
SocketConnectable& operator=(SocketConnectable&& src) noexcept;
~SocketConnectable() noexcept override;
static void add_interface(GType gtype_implementer);
/** 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.
GSocketConnectable* gobj() { return reinterpret_cast<GSocketConnectable*>(gobject_); }
///Provides access to the underlying C GObject.
const GSocketConnectable* gobj() const { return reinterpret_cast<GSocketConnectable*>(gobject_); }
private:
public:
/** Creates a SocketAddressEnumerator for @a connectable.
*
* @newin{2,22}
*
* @return A new SocketAddressEnumerator.
*/
Glib::RefPtr<SocketAddressEnumerator> enumerate();
/** Creates a SocketAddressEnumerator for @a connectable.
*
* @newin{2,22}
*
* @return A new SocketAddressEnumerator.
*/
Glib::RefPtr<const SocketAddressEnumerator> enumerate() const;
/** Creates a SocketAddressEnumerator for @a connectable that will
* return ProxyAddresses for addresses that you must connect
* to via a proxy.
*
* If @a connectable does not implement
* g_socket_connectable_proxy_enumerate(), this will fall back to
* calling g_socket_connectable_enumerate().
*
* @newin{2,26}
*
* @return A new SocketAddressEnumerator.
*/
Glib::RefPtr<SocketAddressEnumerator> proxy_enumerate();
/** Creates a SocketAddressEnumerator for @a connectable that will
* return ProxyAddresses for addresses that you must connect
* to via a proxy.
*
* If @a connectable does not implement
* g_socket_connectable_proxy_enumerate(), this will fall back to
* calling g_socket_connectable_enumerate().
*
* @newin{2,26}
*
* @return A new SocketAddressEnumerator.
*/
Glib::RefPtr<const SocketAddressEnumerator> proxy_enumerate() const;
/** Format a SocketConnectable as a string. This is a human-readable format for
* use in debugging output, and is not a stable serialization format. It is not
* suitable for use in user interfaces as it exposes too much information for a
* user.
*
* If the SocketConnectable implementation does not support string formatting,
* the implementation’s type name will be returned as a fallback.
*
* @newin{2,48}
*
* @return The formatted string.
*/
Glib::ustring to_string() const;
//TODO: Wrap vfuncs?
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::SocketConnectable
*/
Glib::RefPtr<Gio::SocketConnectable> wrap(GSocketConnectable* object, bool take_copy = false);
} // namespace Glib
#endif /* _GIOMM_SOCKETCONNECTABLE_H */