SocketClient

gio.socket_client.SocketClient is a lightweight high-level utility class for connecting to a network host using a connection oriented socket type.

You create a gio.socket_client.SocketClient object, set any options you want, and then call a sync or async connect operation, which returns a gio.socket_connection.SocketConnection subclass on success.

The type of the gio.socket_connection.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 gio.tcp_connection.TcpConnection.

As gio.socket_client.SocketClient is a lightweight object, you don't need to cache it. You can just create a new one any time you need one.

class SocketClient : ObjectG {

this();

void addApplicationProxy(string protocol);

gio.socket_connection.SocketConnection connect(gio.socket_connectable.SocketConnectable connectable, gio.cancellable.Cancellable cancellable);

void connectAsync(gio.socket_connectable.SocketConnectable connectable, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.socket_connection.SocketConnection connectFinish(gio.async_result.AsyncResult result);

gio.socket_connection.SocketConnection connectToHost(string hostAndPort, ushort defaultPort, gio.cancellable.Cancellable cancellable);

void connectToHostAsync(string hostAndPort, ushort defaultPort, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.socket_connection.SocketConnection connectToHostFinish(gio.async_result.AsyncResult result);

gio.socket_connection.SocketConnection connectToService(string domain, string service, gio.cancellable.Cancellable cancellable);

void connectToServiceAsync(string domain, string service, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.socket_connection.SocketConnection connectToServiceFinish(gio.async_result.AsyncResult result);

gio.socket_connection.SocketConnection connectToUri(string uri, ushort defaultPort, gio.cancellable.Cancellable cancellable);

void connectToUriAsync(string uri, ushort defaultPort, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.socket_connection.SocketConnection connectToUriFinish(gio.async_result.AsyncResult result);

bool getEnableProxy();

gio.types.SocketFamily getFamily();

gio.socket_address.SocketAddress getLocalAddress();

gio.types.SocketProtocol getProtocol();

gio.proxy_resolver.ProxyResolver getProxyResolver();

gio.types.SocketType getSocketType();

uint getTimeout();

bool getTls();

gio.types.TlsCertificateFlags getTlsValidationFlags();

void setEnableProxy(bool enable);

void setFamily(gio.types.SocketFamily family);

void setLocalAddress(gio.socket_address.SocketAddress address);

void setProtocol(gio.types.SocketProtocol protocol);

void setProxyResolver(gio.proxy_resolver.ProxyResolver proxyResolver);

void setSocketType(gio.types.SocketType type);

void setTimeout(uint timeout);

void setTls(bool tls);

void setTlsValidationFlags(gio.types.TlsCertificateFlags flags);

ulong connectEvent(T callback, Flag!"After" after);

}

Constructors

this this(): Creates a new #GSocketClient with the default options.

Members

Functions

addApplicationProxy void addApplicationProxy(string protocol): Enable proxy protocols to be handled by the application. When the indicated proxy protocol is returned by the #GProxyResolver, #GSocketClient will consider this protocol as supported but will not try to find a #GProxy instance to handle handshaking. The application must check for this case by calling gio.socket_connection.SocketConnection.getRemoteAddress on the returned #GSocketConnection, and seeing if it's a #GProxyAddress of the appropriate type, to determine whether or not it needs to handle the proxy handshaking itself.
connect gio.socket_connection.SocketConnection connect(gio.socket_connectable.SocketConnectable connectable, gio.cancellable.Cancellable cancellable): Tries to resolve the connectable and make a network connection to it.
connectAsync void connectAsync(gio.socket_connectable.SocketConnectable connectable, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): This is the asynchronous version of gio.socket_client.SocketClient.connect.
connectEvent ulong connectEvent(T callback, Flag!"After" after): Connect to Event signal.
connectFinish gio.socket_connection.SocketConnection connectFinish(gio.async_result.AsyncResult result): Finishes an async connect operation. See gio.socket_client.SocketClient.connectAsync
connectToHost gio.socket_connection.SocketConnection connectToHost(string hostAndPort, ushort defaultPort, gio.cancellable.Cancellable cancellable): This is a helper function for gio.socket_client.SocketClient.connect.
connectToHostAsync void connectToHostAsync(string hostAndPort, ushort defaultPort, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): This is the asynchronous version of gio.socket_client.SocketClient.connectToHost.
connectToHostFinish gio.socket_connection.SocketConnection connectToHostFinish(gio.async_result.AsyncResult result): Finishes an async connect operation. See gio.socket_client.SocketClient.connectToHostAsync
connectToService gio.socket_connection.SocketConnection connectToService(string domain, string service, gio.cancellable.Cancellable cancellable): Attempts to create a TCP connection to a service.
connectToServiceAsync void connectToServiceAsync(string domain, string service, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): This is the asynchronous version of gio.socket_client.SocketClient.connectToService.
connectToServiceFinish gio.socket_connection.SocketConnection connectToServiceFinish(gio.async_result.AsyncResult result): Finishes an async connect operation. See gio.socket_client.SocketClient.connectToServiceAsync
connectToUri gio.socket_connection.SocketConnection connectToUri(string uri, ushort defaultPort, gio.cancellable.Cancellable cancellable): This is a helper function for gio.socket_client.SocketClient.connect.
connectToUriAsync void connectToUriAsync(string uri, ushort defaultPort, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): This is the asynchronous version of gio.socket_client.SocketClient.connectToUri.
connectToUriFinish gio.socket_connection.SocketConnection connectToUriFinish(gio.async_result.AsyncResult result): Finishes an async connect operation. See gio.socket_client.SocketClient.connectToUriAsync
getEnableProxy bool getEnableProxy(): Gets the proxy enable state; see gio.socket_client.SocketClient.setEnableProxy
getFamily gio.types.SocketFamily getFamily(): Gets the socket family of the socket client.
getLocalAddress gio.socket_address.SocketAddress getLocalAddress(): Gets the local address of the socket client.
getProtocol gio.types.SocketProtocol getProtocol(): Gets the protocol name type of the socket client.
getProxyResolver gio.proxy_resolver.ProxyResolver getProxyResolver(): Gets the #GProxyResolver being used by client. Normally, this will be the resolver returned by gio.proxy_resolver.ProxyResolver.getDefault, but you can override it with gio.socket_client.SocketClient.setProxyResolver.
getSocketType gio.types.SocketType getSocketType(): Gets the socket type of the socket client.
getTimeout uint getTimeout(): Gets the I/O timeout time for sockets created by client.
getTls bool getTls(): Gets whether client creates TLS connections. See gio.socket_client.SocketClient.setTls for details.
getTlsValidationFlags gio.types.TlsCertificateFlags getTlsValidationFlags(): Gets the TLS validation flags used creating TLS connections via client.
setEnableProxy void setEnableProxy(bool enable): Sets whether or not client attempts to make connections via a proxy server. When enabled (the default), #GSocketClient will use a #GProxyResolver to determine if a proxy protocol such as SOCKS is needed, and automatically do the necessary proxy negotiation.
setFamily void setFamily(gio.types.SocketFamily family): Sets the socket family of the socket client. If this is set to something other than gio.types.SocketFamily.Invalid then the sockets created by this object will be of the specified family.
setLocalAddress void setLocalAddress(gio.socket_address.SocketAddress address): Sets the local address of the socket client. The sockets created by this object will bound to the specified address (if not null) before connecting.
setProtocol void setProtocol(gio.types.SocketProtocol protocol): Sets the protocol of the socket client. The sockets created by this object will use of the specified protocol.
setProxyResolver void setProxyResolver(gio.proxy_resolver.ProxyResolver proxyResolver): Overrides the #GProxyResolver used by client. You can call this if you want to use specific proxies, rather than using the system default proxy settings.
setSocketType void setSocketType(gio.types.SocketType type): Sets the socket type of the socket client. The sockets created by this object will be of the specified type.
setTimeout void setTimeout(uint timeout): Sets the I/O timeout for sockets created by client. timeout is a time in seconds, or 0 for no timeout (the default).
setTls void setTls(bool tls): Sets whether client creates TLS (aka SSL) connections. If tls is true, client will wrap its connections in a #GTlsClientConnection and perform a TLS handshake when connecting.
setTlsValidationFlags void setTlsValidationFlags(gio.types.TlsCertificateFlags flags): Sets the TLS validation flags used when creating TLS connections via client. The default value is gio.types.TlsCertificateFlags.ValidateAll.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gio socket_client classes

SocketClient