gio/org.gtkkn.bindings.gio/TcpWrapperConnection

TcpWrapperConnection

open class TcpWrapperConnection(pointer: <Error class: unknown class><<Error class: unknown class>>) : TcpConnection

A GTcpWrapperConnection can be used to wrap a class@Gio.IOStream that is based on a class@Gio.Socket, but which is not actually a class@Gio.SocketConnection. This is used by class@Gio.SocketClient so that it can always return a class@Gio.SocketConnection, even when the connection it has actually created is not directly a class@Gio.SocketConnection.

Since

2.28

Constructors

TcpWrapperConnection

constructor(baseIoStream: IOStream, socket: Socket)

Wraps @base_io_stream and @socket together as a #GSocketConnection.

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

Types

Companion

object Companion

Properties

baseIoStream

open val baseIoStream: IOStream

The wrapped class@Gio.IOStream.

gioIOStreamPointer

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

gioSocketConnectionPointer

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

gioTcpConnectionPointer

val gioTcpConnectionPointer: <Error class: unknown class><<Error class: unknown class>>

gioTcpWrapperConnectionPointer

val gioTcpWrapperConnectionPointer: <Error class: unknown class><<Error class: unknown class>>

gracefulDisconnect

open var gracefulDisconnect: Boolean

Whether method@Gio.IOStream.close does a graceful disconnect.

inputStream

open val inputStream: InputStream

The class@Gio.InputStream to read from.

outputStream

open val outputStream: OutputStream

The class@Gio.OutputStream to write to.

socket

open val socket: Socket

The underlying class@Gio.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.

getBaseIoStream

open fun getBaseIoStream(): IOStream

Gets @conn's base #GIOStream

getGracefulDisconnect

open fun getGracefulDisconnect(): Boolean

Checks if graceful disconnects are used. See g_tcp_connection_set_graceful_disconnect().

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.

setGracefulDisconnect

open fun setGracefulDisconnect(gracefulDisconnect: Boolean)

This enables graceful disconnects on close. A graceful disconnect means that we signal the receiving end that the connection is terminated and wait for it to close the connection before closing the connection.

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