Grid Application Toolkit A simple API for Grid Applications

Menu Home API-Specification API-Overview Status C Reference Manual Download Java Java-Reference General GridLab - WP-1 Links

GATMemoryStream.h Go to the documentation of this file. /** @file GATMemoryStream.h * Header file for the GATMemoryStream class. * * @date Wed Oct 29 2003 * * @version $Header: /export/cvs-gridlab/wp-1/Codes/GATEngine/C-reference/src/GATMemoryStream.h,v 1.7 2004/03/24 19:30:58 hartmutkaiser Exp $ * * Copyright (C) Hartmut Kaiser * This file is part of the GAT Engine. * Contributed by 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) */ #if !defined(_GATMemoryStream_H_) #define _GATMemoryStream_H_ /* GAT Header Files */ #include "GATObject.h" #include "GATType.h" /* Structures, unions and enums */ #ifdef __cplusplus extern "C" { #endif /* Declare the converters to/from GATObject */ GATOBJECT_DECLARE_CONVERTERS(GATMemoryStream); /* Create and initialize a new GATMemoryStream instance */ GATMemoryStream GATMemoryStream_Create(void *initial_buffer, GATuint32 initial_size, GATBool takeover_ownership); /* Access the internal buffer of this stream object */ void * GATMemoryStream_GetBuffer(GATMemoryStream object, GATuint32 *buffer_size, GATBool lend_ownership); /* GATObject implementation */ /* Delete an existing GATMemoryStream object */ void GATMemoryStream_Destroy(GATMemoryStream *object); /* Compare two GATMemoryStream objects */ GATResult GATMemoryStream_Equals(GATMemoryStream_const lhs, GATMemoryStream_const rhs, GATBool *isequal); /* Clone a GATMemoryStream object */ GATResult GATMemoryStream_Clone(GATMemoryStream_const object, GATMemoryStream *new_object); /* Return the type of a GATMemoryStream object */ GATType GATMemoryStream_GetType(GATMemoryStream_const object); /* return one of the implemented interfaces */ GATResult GATMemoryStream_GetInterface(GATMemoryStream_const file, GATInterface iftype, void const **ifp); /* IStreamable implementation */ /* Reads from this GATStreamable into the given buffer */ GATResult GATMemoryStream_Read(GATMemoryStream object, void *buffer, GATuint32 size, GATuint32 *read_bytes); /* Writes data from the given Buffer through the GATStreamable */ GATResult GATMemoryStream_Write(GATMemoryStream object, void const *buffer, GATuint32 size, GATuint32 *written_bytes); /* reposition the internal stream position */ GATResult GATMemoryStream_Seek(GATMemoryStream object, GATOrigin origin, GATint32 offset, GATuint32 *new_position); /* Closes this GATStreamable instance. */ GATResult GATMemoryStream_Close(GATMemoryStream object); #if 0 /* Reads from this GATStreamable into the given Buffer, but returning immediately */ GATResult GATMemoryStream_IRead(GATMemoryStream object, void *buffer, GATuint32 size); /* This finishes the current IRead call on this GATStreamable */ GATResult GATMemoryStream_ReadFinish(GATMemoryStream object, GATBool *got_data, GATuint32 *got_bytes); /* This tests if data has been received in the current IRead */ GATResult GATMemoryStream_ReadTest(GATMemoryStream object, GATBool *can_read); /* Writes data from the given Buffer through the GATStreamable, but returns immediately */ GATResult GATMemoryStream_IWrite(GATMemoryStream object, void const *buffer, GATuint32 size); /* This finishes the current IWrite call on this GATStreamable */ GATResult GATMemoryStream_WriteFinish(GATMemoryStream object, GATuint32 *written_bytes); /* Tests if data has been sent from the current IWrite call on this GATStreamable */ GATResult GATMemoryStream_WriteTest(GATMemoryStream object, GATuint32 *written_bytes); #endif /* 0 */ #ifdef __cplusplus } /* extern "C" */ #endif #endif /* !defined(_GATMemoryStream_H_) */