org.scion.jpan

Class ScionSocketOptions

java.lang.Object

org.scion.jpan.ScionSocketOptions

public final class ScionSocketOptions
extends Object

A home for SCION (SN) channel/socket options.

Field Summary

Fields

Modifier and Type	Field and Description
static SocketOption<Boolean>	SCION_API_THROW_PARSER_FAILURE If set to 'true', the Scion header parser will throw errors when encountering problems while parsing a packet header.
static SocketOption<Boolean>	SCION_API_WRITE_TO_USER_BUFFER Deprecated.
static SocketOption<Integer>	SCION_PATH_EXPIRY_MARGIN Before sending a packet, a new path will be requested if now() + pathExpirationMargin > pathExpirationDate.
static SocketOption<Integer>	SCION_TRAFFIC_CLASS Set the traffic class SCION header.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SCION_API_THROW_PARSER_FAILURE

public static final SocketOption<Boolean> SCION_API_THROW_PARSER_FAILURE

If set to 'true', the Scion header parser will throw errors when encountering problems while parsing a packet header. If set to 'false', problematic packets are silently dropped. Default is 'false'.

SCION_API_WRITE_TO_USER_BUFFER

@Deprecated
public static final SocketOption<Boolean> SCION_API_WRITE_TO_USER_BUFFER

Deprecated.

If set to 'true', the receive() and read() operations will read new packets directly into the ByteBuffer provided by the user. The ByteBuffer will contain the header and the position of will be set to the first byte of the payload. This has two advantages: the payload does not need to be copied (saving one copy operation) and the Scion packet header is directly available to the user. If set to 'false', the receive() and read() operations will copy the payload to the ByteBuffer provided by the user. Default is 'false'.

SCION_PATH_EXPIRY_MARGIN

public static final SocketOption<Integer> SCION_PATH_EXPIRY_MARGIN

Before sending a packet, a new path will be requested if now() + pathExpirationMargin > pathExpirationDate.

SCION_TRAFFIC_CLASS

public static final SocketOption<Integer> SCION_TRAFFIC_CLASS

Set the traffic class SCION header.