op_pk_bcast_get()
Abstract
Gets the value of broadcast information.
Syntax
op_pk_bcast_get (pkptr)
| Argument | Type | Description |
|---|---|---|
pkptr |
Packet* |
pointer to the packet-of-interest [A pointer to a packet can be obtained from many KPs, including op_pk_create(), op_pk_create_fmt(), op_pk_copy(), op_pk_get(), op_subq_pk_access(), and op_subq_pk_remove().] |
Return Type
Objid
Object ID of the broadcast information, or OPC_OBJID_NULL if none.
Example
bcast_info = op_pk_bcast_get (pkptr);
Details
None.
Purpose
Provides a mechanism to get the object ID of a broadcast object.
Errors
- Program Abort: Segmentation violation. (due to an invalid packet pointer or malformed packet)
- Program Abort: KP requires process context.
- Program Abort: Packet pointer is NIL.
- Program Abort: Packet pointer references destroyed packet.
- Program Abort: Packet pointer references static packet (
<pk_id>).
Reference
- Use the KP op_pk_bcast_general() to set a packet’s broadcast property to include all possible nodes
- Use the KP op_pk_bcast_unique() to set a packet’s broadcast property to target a single node