UM Java API  6.17.1
com.latencybusters.lbm.LBMSourceCreateExInfo Class Reference

Public Member Functions

 LBMSourceCreateExInfo ()
 
 LBMSourceCreateExInfo (int flags, String proxySourceString, long origDomainId, long hlIndex)
 
String proxySourceString ()
 
long originalDomainId ()
 
long hotlinkIndex ()
 
boolean isHotlink ()
 
int flags ()
 

Detailed Description

LBMSourceCreateExInfo class. Contains extended information for LBM source creation extended callback. See LBMReceiverAttributes.setSourceNotificationExCallbacks().

Since
UM 6.17.1

Constructor & Destructor Documentation

com.latencybusters.lbm.LBMSourceCreateExInfo.LBMSourceCreateExInfo ( )

Creates a LBMSourceCreateExInfo object and initializes all fields to 0/null.

com.latencybusters.lbm.LBMSourceCreateExInfo.LBMSourceCreateExInfo ( int  flags,
String  proxySourceString,
long  origDomainId,
long  hlIndex 
)

Creates a LBMSourceCreateExInfo object and initializes fields to supplied values.

Parameters
flagsFlags set by the underlying controller.
proxySourceStringSource string of the proxy source.
origDomainIdThe domain ID of the originating source.
hlIndexHotlink index of the local connection

References com.latencybusters.lbm.LBMSourceCreateExInfo.flags(), and com.latencybusters.lbm.LBMSourceCreateExInfo.proxySourceString().

Member Function Documentation

int com.latencybusters.lbm.LBMSourceCreateExInfo.flags ( )

For the delivery controller being created, get bit map of flags. See flags() and isHotlink(). Defined bits:

Returns
original domain ID.

Referenced by com.latencybusters.lbm.LBMSourceCreateExInfo.LBMSourceCreateExInfo().

long com.latencybusters.lbm.LBMSourceCreateExInfo.hotlinkIndex ( )

For the delivery controller being created, get the hotlink index. The value is only defined if the config option use_hotlink (receiver) is set to 1. See flags() and isHotlink().

Returns
Hotlink index.
boolean com.latencybusters.lbm.LBMSourceCreateExInfo.isHotlink ( )

Convenience function to test flags() for the LBM.LBM_SOURCE_NOTIFICATION_EX_INFO_FLAG_HOT_LINK bit, meaning the config option use_hotlink (receiver) is set to 1. (It does not imply that publisher's source had lot links enabled.)

Returns
true if the receiver has hotlinks enabled, false otherwise.

References com.latencybusters.lbm.LBM.LBM_SOURCE_NOTIFICATION_EX_INFO_FLAG_HOT_LINK.

long com.latencybusters.lbm.LBMSourceCreateExInfo.originalDomainId ( )

For the delivery controller being created, get originating source's domain ID. The value is only defined if the config option use_hotlink (receiver) is set to 1. See flags() and isHotlink().

Returns
original domain ID.
String com.latencybusters.lbm.LBMSourceCreateExInfo.proxySourceString ( )

For the delivery controller being created, get the source string of the proxy source, if any.

Returns
proxy source string.

Referenced by com.latencybusters.lbm.LBMSourceCreateExInfo.LBMSourceCreateExInfo().


The documentation for this class was generated from the following file: