Package org.gnome.gio

Class Socket.Builder<B extends Socket.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.gio.Socket.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Enclosing class:

Socket

public static class Socket.Builder<B extends Socket.Builder<B>>
extends GObject.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
Socket	build()	Finish building the Socket object.
B	setBlocking(boolean blocking)	Whether I/O on this socket is blocking.
B	setBroadcast(boolean broadcast)	Whether the socket should allow sending to broadcast addresses.
B	setFamily(SocketFamily family)	The socket’s address family.
B	setFd(int fd)	The socket’s file descriptor.
B	setKeepalive(boolean keepalive)	Whether to keep the connection alive by sending periodic pings.
B	setListenBacklog(int listenBacklog)	The number of outstanding connections in the listen queue.
B	setMulticastLoopback(boolean multicastLoopback)	Whether outgoing multicast packets loop back to the local host.
B	setMulticastTtl(int multicastTtl)	Time-to-live out outgoing multicast packets
B	setProtocol(SocketProtocol protocol)	The ID of the protocol to use, or -1 for unknown.
B	setTimeout(int timeout)	The timeout in seconds on socket I/O
B	setTtl(int ttl)	Time-to-live for outgoing unicast packets
B	setType(SocketType type)	The socket’s type.

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class io.github.jwharm.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public Socket build()

Finish building the Socket object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to Socket.

Overrides:

build in class GObject.Builder<B extends Socket.Builder<B>>

Returns:

a new instance of Socket with the properties that were set in the Builder object.

setBlocking

public B setBlocking(boolean blocking)

Whether I/O on this socket is blocking.

Parameters:

blocking - the value for the blocking property

Returns:

the Builder instance is returned, to allow method chaining

setBroadcast

public B setBroadcast(boolean broadcast)

Whether the socket should allow sending to broadcast addresses.

Parameters:

broadcast - the value for the broadcast property

Returns:

the Builder instance is returned, to allow method chaining

setFamily

public B setFamily(SocketFamily family)

The socket’s address family.

Parameters:

family - the value for the family property

Returns:

the Builder instance is returned, to allow method chaining

setFd

public B setFd(int fd)

The socket’s file descriptor.

Parameters:

fd - the value for the fd property

Returns:

the Builder instance is returned, to allow method chaining

setKeepalive

public B setKeepalive(boolean keepalive)

Whether to keep the connection alive by sending periodic pings.

Parameters:

keepalive - the value for the keepalive property

Returns:

the Builder instance is returned, to allow method chaining

setListenBacklog

public B setListenBacklog(int listenBacklog)

The number of outstanding connections in the listen queue.

Parameters:

listenBacklog - the value for the listen-backlog property

Returns:

the Builder instance is returned, to allow method chaining

setMulticastLoopback

public B setMulticastLoopback(boolean multicastLoopback)

Whether outgoing multicast packets loop back to the local host.

Parameters:

multicastLoopback - the value for the multicast-loopback property

Returns:

the Builder instance is returned, to allow method chaining

setMulticastTtl

public B setMulticastTtl(int multicastTtl)

Time-to-live out outgoing multicast packets

Parameters:

multicastTtl - the value for the multicast-ttl property

Returns:

the Builder instance is returned, to allow method chaining

setProtocol

public B setProtocol(SocketProtocol protocol)

The ID of the protocol to use, or -1 for unknown.

Parameters:

protocol - the value for the protocol property

Returns:

the Builder instance is returned, to allow method chaining

setTimeout

public B setTimeout(int timeout)

The timeout in seconds on socket I/O

Parameters:

timeout - the value for the timeout property

Returns:

the Builder instance is returned, to allow method chaining

setTtl

public B setTtl(int ttl)

Time-to-live for outgoing unicast packets

Parameters:

ttl - the value for the ttl property

Returns:

the Builder instance is returned, to allow method chaining

setType

public B setType(SocketType type)

The socket’s type.

Parameters:

type - the value for the type property

Returns:

the Builder instance is returned, to allow method chaining