FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPxEnviron.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_PX_ENVIRON_H
9 #define K_FIRESYNC_PX_ENVIRON_H
10 
11 #include <kFireSync/kNodeDef.h>
12 #include <stdarg.h>
13 
14 kBeginHeader()
15 
16 
21 //typedef kObject kPxEnviron; --forward-declared in kFsDef.x.h
22 
23 
35 kFsFx(kStatus) kPxEnviron_FindVariable(kPxEnviron pipeEnviron, const kChar* name, kObject* object);
36 
47 kFsFx(kStatus) kPxEnviron_FilePath(kPxEnviron pipeEnviron, const kChar* fileName, kChar* filePath, kSize capacity);
48 
58 kFsFx(kStatus) kPxEnviron_Printvf(kPxEnviron pipeEnviron, const kChar* format, va_list args);
59 
67 kFsFx(kAlloc) kPxEnviron_MessageAlloc(kPxEnviron pipeEnviron);
68 
76 kFsFx(kHealth) kPxEnviron_Health(kPxEnviron pipeEnviron);
77 
89 kFsFx(k64u) kPxEnviron_Timestamp(kPxEnviron pipeEnviron);
90 
91 kEndHeader()
92 
93 #include <kFireSync/Pipe/kPxEnviron.x.h>
94 
95 #endif
kPxEnviron
Represents an object that provides external services to a pipe execution engine.
kPxEnviron::kPxEnviron_Printvf
kStatus kPxEnviron_Printvf(kPxEnviron pipeEnviron, const kChar *format, va_list args)
Prints a diagnostic message.
kNodeDef.h
Essential declarations related to FireSync nodes.
kPxEnviron::kPxEnviron_MessageAlloc
kAlloc kPxEnviron_MessageAlloc(kPxEnviron pipeEnviron)
Gets an allocator that should be used to construct output messages.
kPxEnviron::kPxEnviron_FilePath
kStatus kPxEnviron_FilePath(kPxEnviron pipeEnviron, const kChar *fileName, kChar *filePath, kSize capacity)
Gets the full path for a given file name used within a pipe execution environment.
kHealth
Base class for a health statistics collection service.
kPxEnviron::kPxEnviron_FindVariable
kStatus kPxEnviron_FindVariable(kPxEnviron pipeEnviron, const kChar *name, kObject *object)
Gets a reference to a named object.
kPxEnviron::kPxEnviron_Timestamp
k64u kPxEnviron_Timestamp(kPxEnviron pipeEnviron)
Within an embedded node environment, this method can be used to access the current FireSync synchnron...
kPxEnviron::kPxEnviron_Health
kHealth kPxEnviron_Health(kPxEnviron pipeEnviron)
Gets the health service provider for the pipe environment.