GridLab
Grid Application Toolkit

A simple API for Grid Applications
GAT

Menu



Main Page   Alphabetical List   Compound List   File List   Compound Members   File Members  

GATFileStreamCPI.c File Reference

Main .c for the GATFileStreamCPI class. More...

#include <stdio.h>
#include <stdlib.h>
#include "GATFileStreamCPI.h"

Include dependency graph for GATFileStreamCPI.c:

Include dependency graph

Go to the source code of this file.

Compounds

struct  GATFileStreamCPI_S

Functions

int GATFileStreamCPI_IsValidData_V1 (GATFileStreamCPI_Data *data)
GATFileStreamCPI GATFileStreamCPI_Create (unsigned long int version, GATFileStreamCPI_Data *data)
 GATFileStreamCPI_Create The GATFileStreamCPI constructor.

void GATFileStreamCPI_Destroy (GATFileStreamCPI *cpi)
 GATFileStreamCPI_Destroy The GATFileStreamCPI destructor.

GATResult GATFileStreamCPI_CreateInstance (GATFileStreamCPI cpi, GATFileStreamCPI_Instance *data)
 GATFileStreamCPI_CreateInstance Create a new CPI object instance.

void GATFileStreamCPI_DestroyInstance (GATFileStreamCPI cpi, GATFileStreamCPI_Instance *data)
 GATFileStreamCPI_DestroyInstance Create a new CPI object instance.

GATResult GATFileStreamCPI_EqualsInstance (GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *lhs, GATFileStreamCPI_Instance const *rhs, GATBool *isequal)
 GATFileStreamCPI_EqualsInstance Compares two CPI object instances.

GATResult GATFileStreamCPI_CloneInstance (GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATFileStreamCPI_Instance *new_data)
 GATFileStreamCPI_CloneInstance Clones a CPI object instance.

GATResult GATFileStreamCPI_Read (GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, void *buffer, GATuint32 size, GATuint32 *read_bytes)
 GATFileStreamCPI_Read Read from this fileStream.

GATResult GATFileStreamCPI_Write (GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, void const *buffer, GATuint32 size, GATuint32 *written_bytes)
 GATFileStreamCPI_Write Write to this fileStream.

GATResult GATFileStreamCPI_Seek (GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATOrigin origin, GATint32 offset, GATuint32 *new_position)
 GATFileStreamCPI_Seek Seek on this fileStream.

GATResult GATFileStreamCPI_Close (GATFileStreamCPI cpi, GATFileStreamCPI_Instance *data)
 GATFileStreamCPI_Close Closes this fileStream.

GATResult GATFileStreamCPI_GetMetrics (GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATList_GATMetric *metrics)
 GATFileStreamCPI_GetMetrics.

GATResult GATFileStreamCPI_GetMetricEvent (GATFileStreamCPI cpi, GATFileStreamCPI_Instance const *data, GATMetric metric, GATMetricEvent *event)
 GATFileStreamCPI_GetMetricEvent.


Variables

const char * rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATFileStreamCPI.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp $"


Detailed Description

Main .c for the GATFileStreamCPI class.

A GATFileStreamCPI encapsulates all the methods that a GATFileStream capability provider provides.

Date:
Date:
2004/04/02 12:31:57

Version:
Header:
/export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATFileStreamCPI.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp

Copyright (C) Kelly Davis This fileStream is part of the GAT Engine. Contributed by Kelly Davis <kdavis@aei.mpg.de> and Hartmut Kaiser <hartmutkaiser [at] t-online [dot] de>.

Use, modification and distribution is subject to the Gridlab Software License. (See accompanying file GLlicense.txt or copy at http://www.gridlab.org/GLlicense.txt)

Definition in file GATFileStreamCPI.c.


Function Documentation

int GATFileStreamCPI_IsValidData_V1 GATFileStreamCPI_Data   data [static]
 

Definition at line 325 of file GATFileStreamCPI.c.

References GATFileStreamCPI_Data::clone_instance, GATFileStreamCPI_Data::close, GATFileStreamCPI_Data::create_instance, data, GATFileStreamCPI_Data::destroy, GATFileStreamCPI_Data::destroy_instance, GATFileStreamCPI_Data::equals_instance, GATFileStreamCPI_Data::get_metric_event, GATFileStreamCPI_Data::get_metrics, GATFileStreamCPI_Data::read, GATFileStreamCPI_Data::seek, and GATFileStreamCPI_Data::write.

Referenced by GATFileStreamCPI_Create().

GATFileStreamCPI GATFileStreamCPI_Create unsigned long int    version,
GATFileStreamCPI_Data   data
 

GATFileStreamCPI_Create The GATFileStreamCPI constructor.

This is the constructor for GATFileStreamCPI objects.

Parameters:
version  Version of the GATFileStreamCPI_Data structure
data  Pointer to adaptor CPI instance data structure.
Returns:
A new GATFileStreamCPI

Definition at line 76 of file GATFileStreamCPI.c.

References GATFileStreamCPI_S::clone_instance, GATFileStreamCPI_Data::clone_instance, GATFileStreamCPI_S::close, GATFileStreamCPI_Data::close, GATFileStreamCPI_S::create_instance, GATFileStreamCPI_Data::create_instance, data, GATFileStreamCPI_S::data, GATFileStreamCPI_Data::data, GATFileStreamCPI_S::destroy, GATFileStreamCPI_Data::destroy, GATFileStreamCPI_S::destroy_instance, GATFileStreamCPI_Data::destroy_instance, GATFileStreamCPI_S::equals_instance, GATFileStreamCPI_Data::equals_instance, GATFileStreamCPI_IsValidData_V1(), GATFILESTREAMCPI_VERSION, GATTrue, GATFileStreamCPI_S::get_metric_event, GATFileStreamCPI_Data::get_metric_event, GATFileStreamCPI_S::get_metrics, GATFileStreamCPI_Data::get_metrics, GATFileStreamCPI_S::read, GATFileStreamCPI_Data::read, GATFileStreamCPI_S::seek, GATFileStreamCPI_Data::seek, GATFileStreamCPI_S::service_actions, GATFileStreamCPI_Data::service_actions, GATFileStreamCPI_S::write, and GATFileStreamCPI_Data::write.

Referenced by filestream_adaptor_register().

void GATFileStreamCPI_Destroy GATFileStreamCPI   cpi
 

GATFileStreamCPI_Destroy The GATFileStreamCPI destructor.

This is the destructor for GATFileStreamCPI objects.

Parameters:
this  An old GATFileStreamCPI

Definition at line 133 of file GATFileStreamCPI.c.

References cpi.

Referenced by filestream_adaptor_register().

GATResult GATFileStreamCPI_CreateInstance GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance   data
 

GATFileStreamCPI_CreateInstance Create a new CPI object instance.

Calls the adaptor to create a new CPI object instance.

Parameters:
this  The CPI object.
instance_data  The instance data of the attached CPI object
Returns:
An error code.

Definition at line 154 of file GATFileStreamCPI.c.

References cpi, GATFileStreamCPI_S::create_instance, data, and GATFileStreamCPI_S::data.

Referenced by GATFileStream_Create().

void GATFileStreamCPI_DestroyInstance GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance   data
 

GATFileStreamCPI_DestroyInstance Create a new CPI object instance.

Calls the adaptor to destroy a CPI object instance.

Parameters:
this  The CPI object.
instance_data  The instance data of the attached CPI object

Definition at line 168 of file GATFileStreamCPI.c.

References cpi, data, GATFileStreamCPI_S::data, and GATFileStreamCPI_S::destroy_instance.

Referenced by GATFileStream_Destroy().

GATResult GATFileStreamCPI_EqualsInstance GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance const *    lhs,
GATFileStreamCPI_Instance const *    rhs,
GATBool   isequal
 

GATFileStreamCPI_EqualsInstance Compares two CPI object instances.

Calls the adaptor to compare two CPI object instances.

Parameters:
this  The CPI object.
lhs  The instance data of the left CPI object
rhs  The instance data of the right CPI object
isequal  The pointer to the variable, where the result is to be returned to.
Returns:
An error code.

Definition at line 187 of file GATFileStreamCPI.c.

References cpi, GATFileStreamCPI_S::data, GATFileStreamCPI_S::equals_instance, and GATBool.

Referenced by GATFileStream_Equals().

GATResult GATFileStreamCPI_CloneInstance GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance const *    data,
GATFileStreamCPI_Instance   new_data
 

GATFileStreamCPI_CloneInstance Clones a CPI object instance.

Calls the adaptor to clone a CPI object instance.

Parameters:
this  The CPI object.
instance_data  The instance data of the CPI object to clone.
rhs  The new instance data is to be returned here.
Returns:
An error code.

Definition at line 205 of file GATFileStreamCPI.c.

References GATFileStreamCPI_S::clone_instance, cpi, data, and GATFileStreamCPI_S::data.

Referenced by GATFileStream_Clone().

GATResult GATFileStreamCPI_Read GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance const *    data,
void *    buffer,
GATuint32    size,
GATuint32   read_bytes
 

GATFileStreamCPI_Read Read from this fileStream.

Calls the adaptor to read from this fileStream.

Parameters:
cpi  The CPI object.
data  The instance data of the attached CPI object
buffer  The buffer to read into
size  Size of data to read
read_bytes  Number of bytes read
Returns:
An error code.

Definition at line 224 of file GATFileStreamCPI.c.

References cpi, data, GATFileStreamCPI_S::data, GATResult, GATuint32, GATFileStreamCPI_S::read, and size.

Referenced by GATFileStream_Read().

GATResult GATFileStreamCPI_Write GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance const *    data,
void const *    buffer,
GATuint32    size,
GATuint32   written_bytes
 

GATFileStreamCPI_Write Write to this fileStream.

Calls the adaptor to write to this fileStream.

Parameters:
cpi  The CPI object.
data  The instance data of the attached CPI object
buffer  The buffer to write from
size  Size of data to write
read_bytes  Number of bytes written
Returns:
An error code.

Definition at line 242 of file GATFileStreamCPI.c.

References cpi, data, GATFileStreamCPI_S::data, GATResult, GATuint32, size, and GATFileStreamCPI_S::write.

Referenced by GATFileStream_Write().

GATResult GATFileStreamCPI_Seek GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance const *    data,
GATOrigin    origin,
GATint32    offset,
GATuint32   new_position
 

GATFileStreamCPI_Seek Seek on this fileStream.

Calls the adaptor to seek on this fileStream.

Parameters:
cpi  The CPI object.
data  The instance data of the attached CPI object
origin  Where to seek from
offset  Offset of seek
new_position  New position
Returns:
An error code.

Definition at line 261 of file GATFileStreamCPI.c.

References cpi, data, GATFileStreamCPI_S::data, GATint32, GATOrigin, GATuint32, and GATFileStreamCPI_S::seek.

Referenced by GATFileStream_Seek().

GATResult GATFileStreamCPI_Close GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance   data
 

GATFileStreamCPI_Close Closes this fileStream.

Calls the adaptor to close this fileStream.

Parameters:
cpi  The CPI object.
data  The instance data of the attached CPI object
Returns:
An error code.

Definition at line 278 of file GATFileStreamCPI.c.

References GATFileStreamCPI_S::close, cpi, data, and GATFileStreamCPI_S::data.

Referenced by GATFileStream_Close().

GATResult GATFileStreamCPI_GetMetrics GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance const *    data,
GATList_GATMetric *    metrics
 

GATFileStreamCPI_GetMetrics.

The function GATFileStreamCPI_GetMetrics returns the list of metrics supported by this adaptor.

Parameters:
this  The CPI object.
instance_data  The instance data of the attached CPI object
The  pointer to the variable, which receives the resulting list of metrics.
Returns:
An error code.

Definition at line 296 of file GATFileStreamCPI.c.

References cpi, data, GATFileStreamCPI_S::data, and GATFileStreamCPI_S::get_metrics.

Referenced by GATFileStream_Create().

GATResult GATFileStreamCPI_GetMetricEvent GATFileStreamCPI    cpi,
GATFileStreamCPI_Instance const *    data,
GATMetric    metric,
GATMetricEvent   event
 

GATFileStreamCPI_GetMetricEvent.

The function GATFileStreamCPI_GetMetricEvent returns the metric event, which is associated with the given metric.

Parameters:
this  The CPI object.
instance_data  The instance data of the attached CPI object
metric  The continuous metric, for which the metric event is to be returned.
event  The pointer to the variable, which receives the resulting metric event.
Returns:
An error code.

Definition at line 317 of file GATFileStreamCPI.c.

References cpi, data, GATFileStreamCPI_S::data, GATMetric, and GATFileStreamCPI_S::get_metric_event.

Referenced by GATFileStream_RegisterPolling().


Variable Documentation

const char* rcsid = "$Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATFileStreamCPI.c,v 1.5 2004/04/02 12:31:57 hartmutkaiser Exp $" [static]
 

Definition at line 21 of file GATFileStreamCPI.c.