com.dxfeed.api

Enum DXEndpoint.Role

java.lang.Object

java.lang.Enum<DXEndpoint.Role>

com.dxfeed.api.DXEndpoint.Role

All Implemented Interfaces:

Serializable, Comparable<DXEndpoint.Role>

Enclosing class:

DXEndpoint

public static enum DXEndpoint.Role
extends Enum<DXEndpoint.Role>

Represents the role of endpoint that was specified during its creation.

See Also:

DXEndpoint

Enum Constant Summary

Enum Constants

Enum Constant and Description
FEED FEED endpoint connects to the remote data feed provider and is optimized for real-time or delayed data processing (this is a default role).
LOCAL_HUB LOCAL_HUB endpoint is a local hub without ability to establish network connections.
ON_DEMAND_FEED ON_DEMAND_FEED endpoint is similar to FEED, but it is designed to be used with OnDemandService for historical data replay only.
PUBLISHER PUBLISHER endpoint connects to the remote publisher hub (also known as multiplexor) or creates a publisher on the local host.
STREAM_FEED STREAM_FEED endpoint is similar to FEED and also connects to the remote data feed provider, but is designed for bulk parsing of data from files.
STREAM_PUBLISHER STREAM_PUBLISHER endpoint is similar to PUBLISHER and also connects to the remote publisher hub, but is designed for bulk publishing of data.

Method Summary

Modifier and Type	Method and Description
static DXEndpoint.Role	valueOf(String name) Returns the enum constant of this type with the specified name.
static DXEndpoint.Role[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FEED

public static final DXEndpoint.Role FEED

FEED endpoint connects to the remote data feed provider and is optimized for real-time or delayed data processing (this is a default role). DXEndpoint.getFeed() method returns feed object that subscribes to the remote data feed provider and receives events from it. When event processing threads cannot keep up (don't have enough CPU time), data is dynamically conflated to minimize latency between received events and their processing time.

This endpoint is automatically connected to the configured data feed as explained in default properties section.

ON_DEMAND_FEED

public static final DXEndpoint.Role ON_DEMAND_FEED

ON_DEMAND_FEED endpoint is similar to FEED, but it is designed to be used with OnDemandService for historical data replay only. It is configured with default properties, but is not connected automatically to the data provider until OnDemandService.replay method is invoked.

ON_DEMAND_FEED endpoint cannot be connected to an ordinary data feed at all. OnDemandService.stopAndResume() will have a similar effect to OnDemandService.stopAndClear().

See Also:

OnDemandService

STREAM_FEED

public static final DXEndpoint.Role STREAM_FEED

STREAM_FEED endpoint is similar to FEED and also connects to the remote data feed provider, but is designed for bulk parsing of data from files. DXEndpoint.getFeed() method returns feed object that subscribes to the data from the opened files and receives events from them. Events from the files are not conflated, are not skipped, and are processed as fast as possible. Note, that in this role, DXFeed.getLastEvent(E) method does not work.

PUBLISHER

public static final DXEndpoint.Role PUBLISHER

PUBLISHER endpoint connects to the remote publisher hub (also known as multiplexor) or creates a publisher on the local host. DXEndpoint.getPublisher() method returns a publisher object that publishes events to all connected feeds. Note, that in this role, DXFeed.getLastEvent(E) method does not work and time-series subscription is not supported.

This endpoint is automatically connected to the configured data feed as explained in default properties section.

STREAM_PUBLISHER

public static final DXEndpoint.Role STREAM_PUBLISHER

STREAM_PUBLISHER endpoint is similar to PUBLISHER and also connects to the remote publisher hub, but is designed for bulk publishing of data. DXEndpoint.getPublisher() method returns a publisher object that publishes events to all connected feeds. Published events are not conflated, are not skipped, and are processed as fast as possible. Note, that in this role, DXFeed.getLastEvent(E) method does not work and time-series subscription is not supported.

LOCAL_HUB

public static final DXEndpoint.Role LOCAL_HUB

LOCAL_HUB endpoint is a local hub without ability to establish network connections. Events that are published via publisher are delivered to local feed only.

Method Detail

values

public static DXEndpoint.Role[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DXEndpoint.Role c : DXEndpoint.Role.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DXEndpoint.Role valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null