The LoRS API for LboneResolution

Typedef Documentation

typedef struct __lbone_resolution LboneResolution

This is an opaque structure, the members of which a user should not need to access directly.

typedef struct __lbone_resoution_index LboneResolutionIndex

This is a structure held in the depotIndex tree, which maintains the source and destination index of the resolution index.

Function Documentation

int lorsCreateResolutionFromFile (  char *    filename, LboneResolution **    lr, int    metric_index )

From a serialized form, lorsCreateResolutionFromFile() will allow a user to bring the information back into a LboneResolution structure. Parameters: filename  Name and path of serialized file. lr  Pointer into which the new structure will be returned. metric_index  The format of the file allows for different metrics addressable by index. Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsCreateResolutionFromLBone (  IBP_depot    lboneserver, LboneResolution **    lr, int    opt )

UNIMPLEMENTED: Rather than recovering cached information from a local file, it is possible to make a cache from the lbone using information. Parameters: lboneserver  The hostname and port of the LBone server from which to recover resolution data. lr  Pointer into which the new structure will be returned. opt  LBONE_RESOLUTION_NWS LBONE_RESOLUTION_GEO Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsSetResolutionPoint (  LboneResolution *    lr, IBP_depot    src, IBP_depot    dst, double    metric )

Assign a value to the LBone resolution matrix as keyed on the IBP_depot names. Parameters: lr  Pointer to the LboneResolution structure. src  The source detpot. dst  The destination depot. metric  The value describing this pair.

int lorsGetResolutionPoint (  LboneResolution *    lr, IBP_depot    src, IBP_depot    dst, double *    metric )

Retrieve a point from the LBone resolution matrix as keyed on the IBP_depot names. Parameters: lr  Pointer to the LboneResolution structure. src  The source detpot. dst  The destination depot. metric  Pointer to a double into which the value is returned.

int lorsSaveResolutionToFile (  char *    filename, LboneResolution *    lr )

UNIMPLEMENTED: Serialize the LboneResolution structure to disk. Parameters: filename  The filename and path to write data to. lr  The structure to serialize. Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsUpdateDepotPoolFromResolution (  LorsDepotPool *    dp_src, LorsDepotPool *    dp_dst, LboneResolution *    lr, int    opts )

To assist the lorsSet* functions in making choices, lorsUpdateDepotPoolFromResolution() updates the LorsDepotPool with the resolution information appropriate for the Operation. When either dp_src or dp_dst are NULL, it has the same meaning as "localhost", and is suitable for lorsSetStore() or lorsSetLoad(). For lorsSetCopy(), the operation is more complex, and therefore the LboneResolution structure is passed directly to that function. Parameters: dp_src  The source LorsDepotPool dp_dst  The destination LorsDepotPool lr  The LboneResolution structure. opts  ?? Undetermined. ?? Returns: There are various error conditions. See list of all possible errors The LoRS Error List.

int lorsFreeResolution (  LboneResolution *    lr )

Release the resources used by the LboneResolution matrix. Parameters: lr  An LboneResolution structure as returned from a CreateResolution function. Returns: There are various error conditions. See list of all possible errors The LoRS Error List.