FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPxPort Class Reference

Description

Represents a kPxBlock port.

Inheritance diagram for kPxPort:
Inheritance graph

Public Member Functions

kStatus kPxPort_AcceptForeignData (kPxPort port, kBool enable)
 Enables an input port to accept foreign data. More...
 
kBool kPxPort_AsynchronousDataEnabled (kPxPort port)
 Reports whether an output port is configured to emit messages asynchronously. More...
 
kPxBlock kPxPort_Block (kPxPort port)
 Gets the block to which the port belongs. More...
 
kBool kPxPort_CanAcceptForeignData (kPxPort port)
 Reports whether foreign data can be accepted by an input port. More...
 
kPortDirection kPxPort_Direction (kPxPort port)
 Gets the directionality of the port (input vs. More...
 
kBool kPxPort_DropEnabled (kPxPort port)
 Reports whether an output port is allowed to drop messages. More...
 
kStatus kPxPort_EnableAsynchronousData (kPxPort port, kBool enable)
 Enables an output port to emit messages asynchronously. More...
 
kStatus kPxPort_EnableDrop (kPxPort port, kBool enable)
 Enables an output port to drop messages. More...
 
k32u kPxPort_Id (kPxPort port)
 Gets the unique numerical identifier for this port. More...
 
kBool kPxPort_IsRouted (kPxPort port)
 For an output port, reports whether the port is connected to any input ports. More...
 
kMsgSet kPxPort_MessageAt (kPxPort port, kSize index)
 Accesses a message enqueued on this input port. More...
 
kSize kPxPort_MessageCount (kPxPort port)
 Count of enqueued input messages available on this input port. More...
 
kMsgSource kPxPort_MessageSourceAt (kPxPort port, kSize index)
 Accesses source information for a message enqueued on this input port. More...
 
const kCharkPxPort_Name (kPxPort port)
 Gets a descriptive name for the port. More...
 
kStatus kPxPort_RemoveMessage (kPxPort port, kMsgSet *message, kMsgSource *source)
 Dequeues the next input message received on this input port. More...
 

The documentation for this class was generated from the following file: