Class AFTIPCSocketOptions

java.lang.Object

org.newsclub.net.unix.tipc.AFTIPCSocketOptions

@NonNullByDefault
public final class AFTIPCSocketOptions
extends Object

TIPC-specific socket options.

Author:

Christian Kohlschütter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AFTIPCSocketOptions.MessageImportance	The TIPC message importance.

Field Summary

Fields

Modifier and Type	Field	Description
static final AFSocketOption<Integer>	TIPC_CONN_TIMEOUT	Specifies the number of milliseconds connect() will wait before giving up because of lack of response.
static final AFSocketOption<Boolean>	TIPC_DEST_DROPPABLE	This option governs the handling of a sent message if it cannot be delivered to its destination.
static final AFSocketOption<AFTIPCGroupRequest>	TIPC_GROUP_JOIN	Join a communication group.
static final AFSocketOption<Void>	TIPC_GROUP_LEAVE	Leave the previously joined communication group.
static final AFSocketOption<AFTIPCSocketOptions.MessageImportance>	TIPC_IMPORTANCE	This option governs how likely a message sent by the socket is to be affected by congestion.
static final AFSocketOption<Boolean>	TIPC_MCAST_BROADCAST	Force datagram multicasts from this socket to be transmitted as bearer broadcast/multicast (instead of replicated unicast) whenever possible..
static final AFSocketOption<Boolean>	TIPC_MCAST_REPLICAST	Force datagram multicasts from this socket to be transmitted as replicated unicast instead of bearer broadcast/multicast..
static final AFSocketOption<Integer>	TIPC_NODE_RECVQ_DEPTH	Returns the number of messages in the node's receive queue (get only).
static final AFSocketOption<Boolean>	TIPC_NODELAY	If enabled, the Nagle algorithm is disabled.
static final AFSocketOption<Integer>	TIPC_SOCK_RECVQ_DEPTH	Returns the number of messages in the socket's receive queue (get only).
static final AFSocketOption<Integer>	TIPC_SOCK_RECVQ_USED	When using TIPC_SOCK_RECVQ_DEPTH for getsockopt(), it returns the number of buffers in the receive socket buffer which is not so helpful for user space applications.
static final AFSocketOption<Boolean>	TIPC_SRC_DROPPABLE	Controls whether a message should be discarded when link congestion occurs.
static final Void	VOID	Use as value for SocketOptions of type Void.

Method Summary

Methods inherited from class Object

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

Field Details

VOID

public static final Void VOID

Use as value for SocketOptions of type Void.

See Also:

• TIPC_GROUP_LEAVE

TIPC_IMPORTANCE

public static final AFSocketOption<AFTIPCSocketOptions.MessageImportance> TIPC_IMPORTANCE

This option governs how likely a message sent by the socket is to be affected by congestion. A message with higher importance is less likely to be delayed due to link congestion and less likely to be rejected due to receiver congestion.

See Also:

• AFTIPCSocketOptions.MessageImportance

TIPC_SRC_DROPPABLE

public static final AFSocketOption<Boolean> TIPC_SRC_DROPPABLE

Controls whether a message should be discarded when link congestion occurs.

TIPC_DEST_DROPPABLE

public static final AFSocketOption<Boolean> TIPC_DEST_DROPPABLE

This option governs the handling of a sent message if it cannot be delivered to its destination. If set, the message is discarded; otherwise it is returned to the sender. By default, this option is enabled for SOCK_RDM and SOCK_DGRAM sockets, and disabled otherwise.

TIPC_CONN_TIMEOUT

public static final AFSocketOption<Integer> TIPC_CONN_TIMEOUT

Specifies the number of milliseconds connect() will wait before giving up because of lack of response. The default value is 8000 ms.

TIPC_NODE_RECVQ_DEPTH

public static final AFSocketOption<Integer> TIPC_NODE_RECVQ_DEPTH

Returns the number of messages in the node's receive queue (get only).

TIPC_SOCK_RECVQ_DEPTH

public static final AFSocketOption<Integer> TIPC_SOCK_RECVQ_DEPTH

Returns the number of messages in the socket's receive queue (get only).

TIPC_MCAST_BROADCAST

public static final AFSocketOption<Boolean> TIPC_MCAST_BROADCAST

Force datagram multicasts from this socket to be transmitted as bearer broadcast/multicast (instead of replicated unicast) whenever possible..

TIPC_MCAST_REPLICAST

public static final AFSocketOption<Boolean> TIPC_MCAST_REPLICAST

Force datagram multicasts from this socket to be transmitted as replicated unicast instead of bearer broadcast/multicast..

TIPC_GROUP_JOIN

public static final AFSocketOption<AFTIPCGroupRequest> TIPC_GROUP_JOIN

Join a communication group.

TIPC_GROUP_LEAVE

public static final AFSocketOption<Void> TIPC_GROUP_LEAVE

Leave the previously joined communication group. Only valid for setOption. The value is ignored. Use VOID.

TIPC_SOCK_RECVQ_USED

public static final AFSocketOption<Integer> TIPC_SOCK_RECVQ_USED

When using TIPC_SOCK_RECVQ_DEPTH for getsockopt(), it returns the number of buffers in the receive socket buffer which is not so helpful for user space applications. TIPC_SOCK_RECVQ_USED returns the current allocated bytes of the receive socket buffer. This helps user space applications dimension its buffer usage to avoid buffer overload issue.

TIPC_NODELAY

public static final AFSocketOption<Boolean> TIPC_NODELAY

If enabled, the Nagle algorithm is disabled. Similar to StandardSocketOptions.TCP_NODELAY.