com.bloomberglp.blpapi
Class ServiceRegistrationOptions

java.lang.Object
  com.bloomberglp.blpapi.ServiceRegistrationOptions

public final class ServiceRegistrationOptions
extends java.lang.Object

Contains the options which the user can specify when registering a service. To use non-default options to registerService, create an instance and set the required options and then supply it when using the registerService interface.

Nested Class Summary

static class	ServiceRegistrationOptions.RegistrationParts Constants for specifying which part(s) of a service should be registered
static class	ServiceRegistrationOptions.ServiceRegistrationPriority Constants for specifying the priority of registered service.

Constructor Summary

ServiceRegistrationOptions()
Constructs a ServiceRegistrationOptions with well defined defaults for various options.

Method Summary

void	addActiveSubServiceCodeRange(int begin, int end, int priority) Advertises the service to be registered to receive, with the specified 'priority', subscriptions that the resolver has mapped to a service code between the specified 'begin' and the specified 'end' values, inclusive.
java.lang.String	getGroupId() Returns the Group ID for the service to be registered to the specified groupId String.
int	getPartsToRegister() Returns the parts of the service to be registered.
int	getServicePriority() Returns the value of the service priority.
void	setGroupId(java.lang.String groupId) Sets the Group ID for the service to be registered to the specified groupId String.
void	setPartsToRegister(int parts) Sets the parts of the service to be registered to the specified 'parts', which must be a bitwise-or of the options provided in ServiceRegistrationOptions.RegistrationParts, above.
void	setServicePriority(int priority) Sets the priority for this service to the specified non-negative priority.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceRegistrationOptions

public ServiceRegistrationOptions()

Constructs a ServiceRegistrationOptions with well defined defaults for various options. Currently the following defaults are applied.

     groupId                        = null
     priority                       = PRIORITY_HIGH
 

Method Detail

getGroupId

public java.lang.String getGroupId()

Returns the Group ID for the service to be registered to the specified groupId String.

getServicePriority

public int getServicePriority()

Returns the value of the service priority.

getPartsToRegister

public int getPartsToRegister()

Returns the parts of the service to be registered. See ServiceRegistrationOptions.RegistrationParts, above for additional details.

setGroupId

public void setGroupId(java.lang.String groupId)

Sets the Group ID for the service to be registered to the specified groupId String. If groupId length > MAX_GROUP_ID_SIZE (=64) only the first MAX_GROUP_ID_SIZE chars are considered as Group Id.

setServicePriority

public void setServicePriority(int priority)

Sets the priority for this service to the specified non-negative priority. The behavior is undefined unless priority is non-negative.

setPartsToRegister

public void setPartsToRegister(int parts)

Sets the parts of the service to be registered to the specified 'parts', which must be a bitwise-or of the options provided in ServiceRegistrationOptions.RegistrationParts, above. This option defaults to ServiceRegistrationOptions.RegistrationParts.PART_DEFAULT.

addActiveSubServiceCodeRange

public void addActiveSubServiceCodeRange(int begin,
                                         int end,
                                         int priority)

Advertises the service to be registered to receive, with the specified 'priority', subscriptions that the resolver has mapped to a service code between the specified 'begin' and the specified 'end' values, inclusive. The behavior of this function is undefined unless '0 <= begin <= end < (1 << 24)', and 'priority' is non-negative.