com.dxfeed.api
Enum DXEndpoint.Role

java.lang.Object
  extended by java.lang.Enum<DXEndpoint.Role>
      extended by com.dxfeed.api.DXEndpoint.Role
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DXEndpoint.Role>
Enclosing class:
DXEndpoint

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

Role represents the role of this endpoint that was specified during its creation.

See Also:
DXEndpoint

Enum Constant Summary
FEED
          FEED endpoint connects to the remote data feed provider.
LOCAL_HUB
          LOCAL_HUB endpoint is a local hub without ability to establish network connections.
PUBLISHER
          PUBLISHER endpoint connects to the remote publisher hub (also known as multiplexor) or creates a publisher on the local host.
 
Method Summary
static DXEndpoint.Role valueOf(java.lang.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're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, 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. DXEndpoint.getFeed() method returns feed object that subscribes to the remote data feed provider and receives events from it.


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.


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 final DXEndpoint.Role[] values()
Returns an array containing the constants of this enum type, in the order they're 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're declared

valueOf

public static DXEndpoint.Role valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name