public static final class SubscribeData.Builder extends Object
SubscribeData
objects.Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
SubscribeData |
build()
Build
SubscribeData given the current requests made on the
builder. |
SubscribeData.Builder |
setRxFilter(byte[] rxFilter,
int rxFilterLength)
The transmit filter for a passive subsribe session
SubscribeSettings.Builder.setSubscribeType(int) and
SubscribeSettings.SUBSCRIBE_TYPE_PASSIVE . |
SubscribeData.Builder |
setServiceName(String serviceName)
Specify the service name of the subscribe session.
|
SubscribeData.Builder |
setServiceSpecificInfo(byte[] serviceSpecificInfo,
int serviceSpecificInfoLength)
Specify service specific information for the subscribe session.
|
SubscribeData.Builder |
setServiceSpecificInfo(String serviceSpecificInfoStr)
Specify service specific information for the subscribe session - same
as
setServiceSpecificInfo(byte[], int)
but obtaining the data from a String. |
SubscribeData.Builder |
setTxFilter(byte[] txFilter,
int txFilterLength)
The transmit filter for an active subscribe session
SubscribeSettings.Builder.setSubscribeType(int) and
SubscribeSettings.SUBSCRIBE_TYPE_ACTIVE . |
public SubscribeData.Builder setServiceName(String serviceName)
serviceName
- The service name for the subscribe session.builder.setXXX(..).setXXX(..)
.public SubscribeData.Builder setServiceSpecificInfo(byte[] serviceSpecificInfo, int serviceSpecificInfoLength)
serviceSpecificInfo
- A byte-array for the service-specific
information field.serviceSpecificInfoLength
- The length of the byte-array to be
used.builder.setXXX(..).setXXX(..)
.public SubscribeData.Builder setServiceSpecificInfo(String serviceSpecificInfoStr)
setServiceSpecificInfo(byte[], int)
but obtaining the data from a String.serviceSpecificInfoStr
- The service specific information string
to be included (as a byte array) in the subscribe
information.builder.setXXX(..).setXXX(..)
.public SubscribeData.Builder setTxFilter(byte[] txFilter, int txFilterLength)
SubscribeSettings.Builder.setSubscribeType(int)
and
SubscribeSettings.SUBSCRIBE_TYPE_ACTIVE
. Included in
transmitted subscribe packets and used by receivers (passive
publishers) to determine whether they match - in addition to just
relying on the service name.
Format is an LV byte array - the TlvBufferUtils
utility class
is available to form and parse.
txFilter
- The byte-array containing the LV formatted transmit
filter.txFilterLength
- The number of bytes in the transmit filter
argument.builder.setXXX(..).setXXX(..)
.public SubscribeData.Builder setRxFilter(byte[] rxFilter, int rxFilterLength)
SubscribeSettings.Builder.setSubscribeType(int)
and
SubscribeSettings.SUBSCRIBE_TYPE_PASSIVE
. Used by the
subscriber to determine whether they match transmitted publish
packets - in addition to just relying on the service name.
Format is an LV byte array - the TlvBufferUtils
utility class
is available to form and parse.
rxFilter
- The byte-array containing the LV formatted receive
filter.rxFilterLength
- The number of bytes in the receive filter
argument.builder.setXXX(..).setXXX(..)
.public SubscribeData build()
SubscribeData
given the current requests made on the
builder.