tibrvcmTransport_CreateDistributedQueue()
Function
Declaration
tibrv_statustibrvcmTransport_CreateDistributedQueue(
tibrvcmTransport* cmTransport,
tibrvTransport transport,
const char* cmName);
tibrv_statustibrvcmTransport_CreateDistributedQueueEx(
tibrvcmTransport* cmTransport,
tibrvTransport transport,
const char* cmName,
tibrv_u32 workerWeight,
tibrv_u32 workerTasks,
tibrv_u16 schedulerWeight,
tibrv_f64 schedulerHeartbeat,
tibrv_f64 schedulerActivation);
Purpose
Create a distributed queue member.
Remarks
The new distributed queue transport must employ a valid transport for network communications.
All members of a distributed queue must listen to exactly the same set of subjects. See Enforcing Identical Subscriptions in .
To destroy a distributed queue transport, call tibrvcmTransport_Destroy().
|
Parameter |
Description |
||||||
|
|
The program supplies a location, and the function stores the new distributed queue transport in that location. The distributed queue transport remains valid until the program explicitly destroys it. |
||||||
|
|
The new distributed Destroying the distributed |
||||||
|
|
Bind this reusable name to the new distributed The name must be non- For more information, see Reusable Names in . |
||||||
|
|
When the scheduler receives a task, it assigns the task to the available worker with the greatest worker weight. A worker is considered available unless either of these conditions are true:
Programs can set this parameter using the extended function. The brief form supplies the default value, |
||||||
|
|
Task capacity is the maximum number of tasks that a worker can accept. When the number of accepted tasks reaches this maximum, the worker cannot accept additional tasks until it completes one or more of them. When the scheduler receives a task, it assigns the task to the worker with the greatest worker weight—unless the pending tasks assigned to that worker exceed its task capacity. When the preferred worker has too many tasks, the scheduler assigns the new inbound task to the worker with the next greatest worker weight. Programs can set this parameter using the extended function. The value must be a non-negative integer. The brief form supplies the default value, Zero is a special value, indicating that this distributed queue member is a dedicated scheduler (that is, it never accepts tasks). Warning Tuning task capacity to compensate for communication time lag is more complicated than it might seem. Before setting this value to anything other than 1, see Task Capacity in . |
||||||
|
|
Weight represents the ability of this member to fulfill the role of scheduler, relative to other members with the same name. Cooperating distributed queue transports use relative scheduler weight values to elect one transport as the scheduler; members with higher scheduler weight take precedence. Programs can set this parameter using the extended function. Acceptable values range from 0 to 65535. Zero is a special value, indicating that the member can never be the scheduler. The brief form supplies the default value, For more information, see Rank and Weight in . |
||||||
|
|
The scheduler sends heartbeat messages at this interval (in seconds). All members with the same name must specify the same value for this parameter. The value must be strictly positive. To determine the correct value, see Step 4: Choose the Intervals in . Programs can set this parameter using the extended function. The brief form supplies the default value, |
||||||
|
|
When the heartbeat signal from the scheduler has been silent for this interval (in seconds), the member with the greatest scheduler weight takes its place as the new scheduler. All members with the same name must specify the same value for this parameter. The value must be strictly positive. To determine the correct value, see Step 4: Choose the Intervals in . Programs can set this parameter using the extended function. The brief form supplies the default value, |
|
Constant |
Value |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Relationship to CM
Although distributed queue members are a specialized type of CM transport, their behavior is quite different. Distributed queue transports do not support any functions related to sending messages (for a complete list, see the table of disabled functions).
Scheduler recovery and task rescheduling are available only when the task message is a certified message (that is, a certified delivery agreement is in effect between the task sender and the distributed queue transport scheduler).
See Also
Distributed Queue, in