FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kSerialOut.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_SERIAL_OUT_H
9 #define K_FIRESYNC_SERIAL_OUT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kSerialOut; --forward-declared in kFsDef.x.h
22 
23 
30 kFsFx(kSize) kSerialOut_Id(kSerialOut serial);
31 
39 kFsFx(kStatus) kSerialOut_Clear(kSerialOut serial);
40 
52 kFsFx(kStatus) kSerialOut_Enable(kSerialOut serial, kBool enable);
53 
62 
75 
84 
94 
107 
115 kFsFx(k32u) kSerialOut_ControlId(kSerialOut serial);
116 
125 kFsFx(kStatus) kSerialOut_ControlIdInfo(kSerialOut serial, kInfo* info);
126 
136 
145 
154 kFsFx(kStatus) kSerialOut_ModeInfo(kSerialOut serial, kInfoBits* info);
155 
164 kFsFx(kStatus) kSerialOut_SetBitRate(kSerialOut serial, k32u rate);
165 
173 kFsFx(k32u) kSerialOut_BitRate(kSerialOut serial);
174 
183 kFsFx(kStatus) kSerialOut_BitRateInfo(kSerialOut serial, kInfo32u* info);
184 
194 kFsFx(kStatus) kSerialOut_Write(kSerialOut serial, const void* buffer, kSize size);
195 
204 kFsFx(kStatus) kSerialOut_Stats(kSerialOut serial, kSerialOutStats* stats);
205 
206 kEndHeader()
207 
208 #include <kFireSync/Client/kSerialOut.x.h>
209 
210 #endif
kStatus kSerialOut_SetControl(kSerialOut serial, kSerialOutControl type)
Sets the control mode of the serial.
kStatus kSerialOut_ControlInfo(kSerialOut serial, kInfoBits *info)
Reports constraint and validity information for the Control setting.
Represents serial output control modes.
Represents serial output data modes.
kStatus kSerialOut_SetBitRate(kSerialOut serial, k32u rate)
Sets the bit rate for a serial.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:454
kSerialOutControl kSerialOut_Control(kSerialOut serial)
Reports the control mode of the serial.
k32u kSerialOut_ControlId(kSerialOut serial)
Gets the control source id for a serial.
kBool kSerialOut_IsEnabled(kSerialOut serial)
Reports whether the serial is currently enabled.
Essential declarations related to FireSync nodes.
kSize kSerialOut_Id(kSerialOut serial)
Gets the id of the output.
kStatus kSerialOut_BitRateInfo(kSerialOut serial, kInfo32u *info)
Reports constraint and validity information for the bit rate setting.
kSerialOutMode kSerialOut_Mode(kSerialOut serial)
Gets the mode for a serial.
kStatus kSerialOut_ControlIdInfo(kSerialOut serial, kInfo *info)
Reports constraint and validity information for the ControlId setting.
kStatus kSerialOut_Enable(kSerialOut serial, kBool enable)
Enables or disables the serial.
Represents serial output run-time statistics.
Definition: kNodeDef.h:1197
kStatus kSerialOut_Stats(kSerialOut serial, kSerialOutStats *stats)
Retrieve statistics.
kStatus kSerialOut_SetMode(kSerialOut serial, kSerialOutMode mode)
Sets the mode for a serial.
kStatus kSerialOut_Write(kSerialOut serial, const void *buffer, kSize size)
Transmit data buffer.
kStatus kSerialOut_ModeInfo(kSerialOut serial, kInfoBits *info)
Reports constraint and validity information for the mode setting.
Represents serial configuration.
kStatus kSerialOut_Clear(kSerialOut serial)
Resets serial output mode settings to defaults.
Represents constraint and validity information for a 32-bit unsigned integer setting.
Definition: kInfo.h:79
kStatus kSerialOut_SetControlId(kSerialOut serial, k32u id)
Sets the control source id for a serial.
k32u kSerialOut_BitRate(kSerialOut serial)
Gets the bit rate for a serial.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:45