gio/org.gtkkn.bindings.gio/SocketConnection

SocketConnection

open class SocketConnection(pointer: <Error class: unknown class><<Error class: unknown class>>) : IOStream

#GSocketConnection is a #GIOStream for a connected socket. They can be created either by #GSocketClient when connecting to a host, or by #GSocketListener when accepting a new client.

The type of the #GSocketConnection object returned from these calls depends on the type of the underlying socket that is in use. For instance, for a TCP/IP connection it will be a #GTcpConnection.

Choosing what type of object to construct is done with the socket connection factory, and it is possible for 3rd parties to register custom socket connection types for specific combination of socket family/type/protocol using g_socket_connection_factory_register_type().

To close a #GSocketConnection, use g_io_stream_close(). Closing both substreams of the #GIOStream separately will not close the underlying #GSocket.

Since

2.22

Inheritors

TcpConnection

UnixConnection

Constructors

SocketConnection

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gioIOStreamPointer

val gioIOStreamPointer: <Error class: unknown class><<Error class: unknown class>>

gioSocketConnectionPointer

val gioSocketConnectionPointer: <Error class: unknown class><<Error class: unknown class>>

inputStream

open val inputStream: InputStream

outputStream

open val outputStream: OutputStream

socket

open val socket: Socket

Functions

clearPending

open fun clearPending()

Clears the pending flag on @stream.

open fun close(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Closes the stream, releasing resources related to it. This will also close the individual input and output streams, if they are not already closed.

closeAsync

open fun closeAsync(ioPriority: Int, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_io_stream_close_finish() to get the result of the operation.

closeFinish

open fun closeFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Closes a stream.

connect

open fun connect(address: SocketAddress, cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Connect @connection to the specified remote address.

connectAsync

open fun connectAsync(address: SocketAddress, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Asynchronously connect @connection to the specified remote address.

connectFinish

open fun connectFinish(result: AsyncResult): <Error class: unknown class><Boolean>

Gets the result of a g_socket_connection_connect_async() call.

getInputStream

open fun getInputStream(): InputStream

Gets the input stream for this object. This is used for reading.

getLocalAddress

open fun getLocalAddress(): <Error class: unknown class><SocketAddress>

Try to get the local address of a socket connection.

getOutputStream

open fun getOutputStream(): OutputStream

Gets the output stream for this object. This is used for writing.

getRemoteAddress

open fun getRemoteAddress(): <Error class: unknown class><SocketAddress>

Try to get the remote address of a socket connection.

getSocket

open fun getSocket(): Socket

Gets the underlying #GSocket object of the connection. This can be useful if you want to do something unusual on it not supported by the #GSocketConnection APIs.

hasPending

open fun hasPending(): Boolean

Checks if a stream has pending actions.

isClosed

open fun isClosed(): Boolean

Checks if a stream is closed.

isConnected

open fun isConnected(): Boolean

Checks if @connection is connected. This is equivalent to calling g_socket_is_connected() on @connection's underlying #GSocket.

setPending

open fun setPending(): <Error class: unknown class><Boolean>

Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return false and set

spliceAsync

open fun spliceAsync(stream2: IOStream, flags: IOStreamSpliceFlags, ioPriority: Int, cancellable: Cancellable? = null, callback: AsyncReadyCallback)

Asynchronously splice the output stream of @stream1 to the input stream of