FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kRoute.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_ROUTE_H
9 #define K_FIRESYNC_ROUTE_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kRoute; --forward-declared in kFsDef.x.h
22 
23 
31 kFsFx(kStatus) kRoute_SetSource(kRoute route, const kRoutePoint* source);
32 
40 kFsFx(const kRoutePoint*) kRoute_Source(kRoute route);
41 
50 kFsFx(kStatus) kRoute_SetDestination(kRoute route, const kRoutePoint* destination);
51 
59 kFsFx(const kRoutePoint*) kRoute_Destination(kRoute route);
60 
73 kFsFx(kStatus) kRoute_Info(kRoute route, kInfo* info);
74 
75 kEndHeader()
76 
77 #include <kFireSync/Client/kRoute.x.h>
78 
79 #endif
kRoute::kRoute_Destination
const kRoutePoint * kRoute_Destination(kRoute route)
Returns end-point information for the route destination.
kRoute::kRoute_SetSource
kStatus kRoute_SetSource(kRoute route, const kRoutePoint *source)
Sets end-point information for the route source.
kRoute::kRoute_Source
const kRoutePoint * kRoute_Source(kRoute route)
Returns end-point information for the route source.
kNodeDef.h
Essential declarations related to FireSync nodes.
kRoute
Represents configuration for a pipe message route.
kRoute::kRoute_SetDestination
kStatus kRoute_SetDestination(kRoute route, const kRoutePoint *destination)
Sets end-point information for the route destination.
kRoute::kRoute_Info
kStatus kRoute_Info(kRoute route, kInfo *info)
Returns constraint and validity information for the route.
kRoutePoint
Represents a source or destination endpoint address for a pipe data route.
Definition: kNodeDef.h:1516
kInfo
Represents constraint and validity information for a general setting.
Definition: kInfo.h:45