class: TcpConnection

[13:7] extends: object

This is the subclass of [class@Gio.SocketConnection] that is created for TCP/IP sockets.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• TcpConnection (Handle = null)

  Creates a new TcpConnection by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asSocketConnection ()

  Wraps this handle as SocketConnection.

  • @r A SocketConnection object.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setGracefuldisconnect (bool Value)

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

  • @p Value is the new property value.
  • @r None.

• get_graceful_disconnect ()

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

• set_graceful_disconnect (bool graceful_disconnect)

  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. A graceful disconnect means that we can be sure that we successfully sent all the outstanding data to the other end, or get an error reported. However, it also means we have to wait for all the data to reach the other side and for it to acknowledge this by closing the socket, which may take a while. For this reason it is disabled by default.

  • @p graceful_disconnect is Whether to do graceful disconnects or not.
  • @r None.

class: TcpConnectionMeta

[161:14] static extends: object

Generated metadata helpers for TcpConnection class surfaces.

Methods

• properties ()

  Returns property metadata for TcpConnection.

  • @r A list.