| |
Options |
Name |
Purpose |
|
|
|
OpenEdge.Messaging.RecordBuilder AddHeader (character, longchar)
|
/**
Add a header to the message, with the value specified as a LONGCHAR.
@param name The name of the record header.
@param val The LONGCHAR value of the record header.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder AddHeader (character, memptr)
|
/**
Add a header to the message, with the value specified as a MEMPTR
@param name The name of the record header.
@param val The MEMPTR value of the record header.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder AddHeader (RecordHeader)
|
/**
Add a record header that is to be added to the record when it is built.
@param recordHeader The record header to add.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.IProducerRecord Build ()
|
/**
Calling this generates a new producer record from the current state of the
record builder.
@return A record to be sent over the network by a producer.
*/
|
|
|
|
OpenEdge.Messaging.ProducerRecord CreateRecord ()
|
/**
Overridable method that allows messaging implementation specific
creation of a particular type of record object.
Only primitive data types are copied over as options.
@return A producer record to be sent over the network by a producer.
*/
|
|
|
|
OpenEdge.Messaging.ProducerRecord ProduceRecord ()
|
/**
Overridable method that allows messaging implementation specific
configuration of a record.
@return A producer record to be sent over the network by a producer.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder SetBody (longchar)
|
/**
Assign the body of the message to the given longchar value.
This replaces any other body already stored by the
record builder
The serializer configured by the producer must
handle the conversion of the message to a memptr for
the producer implementation.
@param body The body of the record as a LONGCHAR.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder SetBody (memptr)
|
/***
Assign the body of the record that will be created to the given
memptr.
@param body The body of the record as a MEMPTR.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder SetBody (Object)
|
/**
Assign the body of the message to the given object.
This replaces any other body already stored by the
record builder
The serializer configured by the producer must
handle the conversion of the message to a memptr for
the producer implementation.
@param body The body of the record as an Object.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder SetPartitionId (integer)
|
/**
Directly assign the partition id. This value will only be used
if the messaging implementation supports partitions. For message
implementations that support partitioning, the partition id determines
which partition the record is sent to. if this value is unassigned,
then the partition key will be used to determine which destination
partition.
@param partitionId The partition id where the record will be sent.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder SetPartitionKey (character)
|
/**
Assign the partition key as a string that will be used to determine the partition where the record will be sent.
This may be any character value or the uknown value subject to the limitations
of the producer implementation.
The value may be used by the producer to determine which partition will receive
the message. This value will only be used if the messaging implementation supports partitions.
If the messaging implementation supports it, the record's partition id, if assigned, will be used instead of the partition key.
if the partition id remains unassigned, then the partition key will be hashed to select the partition
where the record will be sent. If both remain unassigned, the producer implementation is free to
select a partition, and the choice will vary by messaging implementation.
@param partitionKey The partition key used to select the partition where the record will be sent.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder SetPartitionKey (longchar)
|
/**
Assign the partition key as a longchar used to create the ProducerRecord.
This may be any longchar value or the uknown value subject to the limitations
of the producer implemtnation.
This value may be used by the producer to determine which partition will receive
the message. This value will only be used if the messaging implementation supports partitions.
If the messaging implementation supports it, the record's partition id, if assigned, will be used instead of the partition key.
if the partition id remains unassigned, then the partition key will be hashed to select the partition
where the record will be sent. If both remain unassigned, the producer implementation is free to
select a partition, and the choice will vary by messaging implementation.
@param partitionKey The partition key used to select the partition where the record will be sent.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder SetRecordOption (character, character)
|
/**
Set a record option. The record builder may use this information to construct
the final Record that is to be sent.
@param the name of a record option.
@param The value of the record option.
@return This record builder. If name is specified as unknown or is empty, return ?
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder SetTimeStamp (datetime-tz)
|
/**
Assign a timestamp of when the record was created.
The producer implementation is free to use this value or
assign its own timestamp to the message, if timestamps are supported.
The timestamp may not be negative.
@param timestamp The timestamp of when the record was constructed.
@return This record builder.
*/
|
|
|
|
OpenEdge.Messaging.RecordBuilder SetTopicName (character)
|
/**
The name of the topic this record is being sent to. The destination topic
cannot be unknown or blank.
@param topicName The name of the destination topic where the record will be sent.
@return This record builder.
*/
|