FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPxPort.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_PX_PORT_H
9 #define K_FIRESYNC_PX_PORT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kPxPort; --forward-declared in kFsDef.x.h
22 
23 
30 kFsFx(k32u) kPxPort_Id(kPxPort port);
31 
39 kFsFx(const kChar*) kPxPort_Name(kPxPort port);
40 
48 kFsFx(kPortDirection) kPxPort_Direction(kPxPort port);
49 
57 kFsFx(kPxBlock) kPxPort_Block(kPxPort port);
58 
69 kFsFx(kBool) kPxPort_IsRouted(kPxPort port);
70 
78 kFsFx(kSize) kPxPort_MessageCount(kPxPort port);
79 
88 kFsFx(kMsgSet) kPxPort_MessageAt(kPxPort port, kSize index);
89 
98 kFsFx(kMsgSource) kPxPort_MessageSourceAt(kPxPort port, kSize index);
99 
109 kFsFx(kStatus) kPxPort_RemoveMessage(kPxPort port, kMsgSet* message, kMsgSource* source);
110 
111 kEndHeader()
112 
113 #include <kFireSync/Pipe/kPxPort.x.h>
114 
115 #endif
kPxPort
Represents a kPxBlock port.
kPxPort::kPxPort_MessageSourceAt
kMsgSource kPxPort_MessageSourceAt(kPxPort port, kSize index)
Accesses source information for a message enqueued on this input port.
kMsgSource
Represents information about the source of a pipe message.
Definition: kNodeDef.h:2160
kPxPort::kPxPort_MessageCount
kSize kPxPort_MessageCount(kPxPort port)
Count of enqueued input messages available on this input port.
kPxPort::kPxPort_Name
const kChar * kPxPort_Name(kPxPort port)
Gets a descriptive name for the port.
kPxPort::kPxPort_IsRouted
kBool kPxPort_IsRouted(kPxPort port)
For an output port, reports whether the port is connected to any input ports.
kPxPort::kPxPort_Id
k32u kPxPort_Id(kPxPort port)
Gets the unique numerical identifier for this port.
kNodeDef.h
Essential declarations related to FireSync nodes.
kPxBlock
Abstract base class for pipe block implementations.
kPxPort::kPxPort_MessageAt
kMsgSet kPxPort_MessageAt(kPxPort port, kSize index)
Accesses a message enqueued on this input port.
kPxPort::kPxPort_Block
kPxBlock kPxPort_Block(kPxPort port)
Gets the block to which the port belongs.
kPortDirection
Represents the directionality of a block port.
kPxPort::kPxPort_Direction
kPortDirection kPxPort_Direction(kPxPort port)
Gets the directionality of the port (input vs.
kPxPort::kPxPort_RemoveMessage
kStatus kPxPort_RemoveMessage(kPxPort port, kMsgSet *message, kMsgSource *source)
Dequeues the next input message received on this input port.
kMsgSet
Abstract base class for FireSync data messages.