2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=UTF-8" >
< title > ChibiOS/RT: chstreams.h Source File< / title >
< link href = "custom.css" rel = "stylesheet" type = "text/css" >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" >
< / head > < body >
< table style = "text-align: center; width: 100%;" border = "0"
cellpadding="2" cellspacing="2">
< tbody >
< tr >
< td style = "width: 80px;" > < img alt = "ChibiOS/RT Logo" src = "logo_small.png" > < / td >
< td > < big > < big > ChibiOS/RT< / big > < / big > < br > < br > Architecture - Reference Manual - Guides< / td >
< td style = "width: 80px;" > < / td >
< / tr >
< / tbody >
< / table >
< hr size = "1" >
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
< div class = "navigation" id = "top" >
< div class = "tabs" >
2010-11-22 05:53:37 +00:00
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "main.html" > < span > Main Page< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data Structures< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "tabs2" >
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "files.html" > < span > File List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > Globals< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "header" >
< div class = "headertitle" >
< h1 > chstreams.h< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "chstreams_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < pre class = "fragment" > < a name = "l00001" > < / a > 00001 < span class = "comment" > /*< / span >
2010-08-10 03:11:02 +00:00
< a name = "l00002" > < / a > 00002 < span class = "comment" > ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.< / span >
< a name = "l00003" > < / a > 00003 < span class = "comment" > < / span >
< a name = "l00004" > < / a > 00004 < span class = "comment" > This file is part of ChibiOS/RT.< / span >
< a name = "l00005" > < / a > 00005 < span class = "comment" > < / span >
< a name = "l00006" > < / a > 00006 < span class = "comment" > ChibiOS/RT is free software; you can redistribute it and/or modify< / span >
< a name = "l00007" > < / a > 00007 < span class = "comment" > it under the terms of the GNU General Public License as published by< / span >
< a name = "l00008" > < / a > 00008 < span class = "comment" > the Free Software Foundation; either version 3 of the License, or< / span >
< a name = "l00009" > < / a > 00009 < span class = "comment" > (at your option) any later version.< / span >
< a name = "l00010" > < / a > 00010 < span class = "comment" > < / span >
< a name = "l00011" > < / a > 00011 < span class = "comment" > ChibiOS/RT is distributed in the hope that it will be useful,< / span >
< a name = "l00012" > < / a > 00012 < span class = "comment" > but WITHOUT ANY WARRANTY; without even the implied warranty of< / span >
< a name = "l00013" > < / a > 00013 < span class = "comment" > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the< / span >
< a name = "l00014" > < / a > 00014 < span class = "comment" > GNU General Public License for more details.< / span >
< a name = "l00015" > < / a > 00015 < span class = "comment" > < / span >
< a name = "l00016" > < / a > 00016 < span class = "comment" > You should have received a copy of the GNU General Public License< / span >
< a name = "l00017" > < / a > 00017 < span class = "comment" > along with this program. If not, see < http://www.gnu.org/licenses/> .< / span >
< a name = "l00018" > < / a > 00018 < span class = "comment" > < / span >
< a name = "l00019" > < / a > 00019 < span class = "comment" > ---< / span >
< a name = "l00020" > < / a > 00020 < span class = "comment" > < / span >
< a name = "l00021" > < / a > 00021 < span class = "comment" > A special exception to the GPL can be applied should you wish to distribute< / span >
< a name = "l00022" > < / a > 00022 < span class = "comment" > a combined work that includes ChibiOS/RT, without being obliged to provide< / span >
< a name = "l00023" > < / a > 00023 < span class = "comment" > the source code for any proprietary components. See the file exception.txt< / span >
< a name = "l00024" > < / a > 00024 < span class = "comment" > for full details of how and when the exception can be applied.< / span >
< a name = "l00025" > < / a > 00025 < span class = "comment" > */< / span >
< a name = "l00026" > < / a > 00026 < span class = "comment" > < / span >
< a name = "l00027" > < / a > 00027 < span class = "comment" > /**< / span >
< a name = "l00028" > < / a > 00028 < span class = "comment" > * @file chstreams.h< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief Data streams.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > * @details This header defines abstract interfaces useful to access generic< / span >
< a name = "l00031" > < / a > 00031 < span class = "comment" > * data streams in a standardized way.< / span >
< a name = "l00032" > < / a > 00032 < span class = "comment" > *< / span >
< a name = "l00033" > < / a > 00033 < span class = "comment" > * @addtogroup data_streams< / span >
< a name = "l00034" > < / a > 00034 < span class = "comment" > * @details This module define an abstract interface for generic data streams.< / span >
< a name = "l00035" > < / a > 00035 < span class = "comment" > * Note that no code is present, streams are just abstract interfaces< / span >
< a name = "l00036" > < / a > 00036 < span class = "comment" > * like structures, you should look at the systems as to a set of< / span >
< a name = "l00037" > < / a > 00037 < span class = "comment" > * abstract C++ classes (even if written in C). This system has the< / span >
< a name = "l00038" > < / a > 00038 < span class = "comment" > * advantage to make the access to streams independent from the< / span >
< a name = "l00039" > < / a > 00039 < span class = "comment" > * implementation logic.< br> < / span >
< a name = "l00040" > < / a > 00040 < span class = "comment" > * The stream interface can be used as base class for high level< / span >
< a name = "l00041" > < / a > 00041 < span class = "comment" > * object types such as files, sockets, serial ports, pipes etc.< / span >
< a name = "l00042" > < / a > 00042 < span class = "comment" > * @{< / span >
< a name = "l00043" > < / a > 00043 < span class = "comment" > */< / span >
< a name = "l00044" > < / a > 00044
< a name = "l00045" > < / a > 00045 < span class = "preprocessor" > #ifndef _CHSTREAMS_H_< / span >
< a name = "l00046" > < / a > 00046 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define _CHSTREAMS_H_< / span >
< a name = "l00047" > < / a > 00047 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00048" > < / a > 00048 < span class = "comment" > /**< / span >
< a name = "l00049" > < / a > 00049 < span class = "comment" > * @brief BaseSequentialStream specific methods.< / span >
< a name = "l00050" > < / a > 00050 < span class = "comment" > */< / span >
2010-11-22 05:53:37 +00:00
< a name = "l00051" > < / a > < a class = "code" href = "group__data__streams.html#ga5323b44ccf2eee6e0f3ef7b22fb55eeb" > 00051< / a > < span class = "preprocessor" > #define _base_sequential_stream_methods \< / span >
2010-08-10 03:11:02 +00:00
< a name = "l00052" > < / a > 00052 < span class = "preprocessor" > < / span > < span class = "comment" > /* Stream write buffer method.*/< / span > \
< a name = "l00053" > < / a > 00053 size_t (*write)(void *instance, const uint8_t *bp, size_t n); \
< a name = "l00054" > < / a > 00054 < span class = "comment" > /* Stream read buffer method.*/< / span > \
< a name = "l00055" > < / a > 00055 size_t (*read)(void *instance, uint8_t *bp, size_t n);
< a name = "l00056" > < / a > 00056 < span class = "comment" > < / span >
< a name = "l00057" > < / a > 00057 < span class = "comment" > /**< / span >
< a name = "l00058" > < / a > 00058 < span class = "comment" > * @brief @p BaseSequentialStream specific data.< / span >
< a name = "l00059" > < / a > 00059 < span class = "comment" > * @note It is empty because @p BaseSequentialStream is only an interface< / span >
< a name = "l00060" > < / a > 00060 < span class = "comment" > * without implementation.< / span >
< a name = "l00061" > < / a > 00061 < span class = "comment" > */< / span >
2010-11-22 05:53:37 +00:00
< a name = "l00062" > < / a > < a class = "code" href = "group__data__streams.html#gabac5bf050a931f5a3be6cac09ba7b373" > 00062< / a > < span class = "preprocessor" > #define _base_sequential_stream_data< / span >
2010-08-10 03:11:02 +00:00
< a name = "l00063" > < / a > 00063 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00064" > < / a > 00064 < span class = "comment" > /**< / span >
< a name = "l00065" > < / a > 00065 < span class = "comment" > * @brief @p BaseSequentialStream virtual methods table.< / span >
< a name = "l00066" > < / a > 00066 < span class = "comment" > */< / span >
< a name = "l00067" > < / a > < a class = "code" href = "struct_base_sequential_stream_v_m_t.html" > 00067< / a > < span class = "keyword" > struct < / span > < a class = "code" href = "struct_base_sequential_stream_v_m_t.html" title = "BaseSequentialStream virtual methods table." > BaseSequentialStreamVMT< / a > {
2010-11-22 05:53:37 +00:00
< a name = "l00068" > < / a > 00068 < a class = "code" href = "group__data__streams.html#ga5323b44ccf2eee6e0f3ef7b22fb55eeb" title = "BaseSequentialStream specific methods." > _base_sequential_stream_methods< / a >
2010-08-10 03:11:02 +00:00
< a name = "l00069" > < / a > 00069 };
< a name = "l00070" > < / a > 00070 < span class = "comment" > < / span >
< a name = "l00071" > < / a > 00071 < span class = "comment" > /**< / span >
< a name = "l00072" > < / a > 00072 < span class = "comment" > * @brief Base stream class.< / span >
< a name = "l00073" > < / a > 00073 < span class = "comment" > * @details This class represents a generic blocking unbuffered sequential< / span >
< a name = "l00074" > < / a > 00074 < span class = "comment" > * data stream.< / span >
< a name = "l00075" > < / a > 00075 < span class = "comment" > */< / span >
< a name = "l00076" > < / a > < a class = "code" href = "struct_base_sequential_stream.html" > 00076< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > struct < / span > {< span class = "comment" > < / span >
< a name = "l00077" > < / a > 00077 < span class = "comment" > /** @brief Virtual Methods Table.*/< / span >
< a name = "l00078" > < / a > < a class = "code" href = "struct_base_sequential_stream.html#a00227dcbf484e37596cf43c075ac90a8" > 00078< / a > < span class = "keyword" > const< / span > < span class = "keyword" > struct < / span > < a class = "code" href = "struct_base_sequential_stream_v_m_t.html" title = "BaseSequentialStream virtual methods table." > BaseSequentialStreamVMT< / a > *vmt;
2010-11-22 05:53:37 +00:00
< a name = "l00079" > < / a > 00079 < a class = "code" href = "group__data__streams.html#gabac5bf050a931f5a3be6cac09ba7b373" title = "BaseSequentialStream specific data." > _base_sequential_stream_data< / a >
2010-08-10 03:11:02 +00:00
< a name = "l00080" > < / a > 00080 } < a class = "code" href = "struct_base_sequential_stream.html" title = "Base stream class." > BaseSequentialStream< / a > ;
< a name = "l00081" > < / a > 00081 < span class = "comment" > < / span >
< a name = "l00082" > < / a > 00082 < span class = "comment" > /**< / span >
< a name = "l00083" > < / a > 00083 < span class = "comment" > * @brief Sequential Stream write.< / span >
< a name = "l00084" > < / a > 00084 < span class = "comment" > * @details The function writes data from a buffer to a stream.< / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > *< / span >
< a name = "l00086" > < / a > 00086 < span class = "comment" > * @param[in] ip pointer to a @p BaseSequentialStream or derived class< / span >
< a name = "l00087" > < / a > 00087 < span class = "comment" > * @param[in] bp pointer to the data buffer< / span >
< a name = "l00088" > < / a > 00088 < span class = "comment" > * @param[in] n the maximum amount of data to be transferred< / span >
< a name = "l00089" > < / a > 00089 < span class = "comment" > * @return The number of bytes transferred. The return value can< / span >
< a name = "l00090" > < / a > 00090 < span class = "comment" > * be less than the specified number of bytes if the< / span >
< a name = "l00091" > < / a > 00091 < span class = "comment" > * stream reaches a physical end of file and cannot be< / span >
< a name = "l00092" > < / a > 00092 < span class = "comment" > * extended.< / span >
< a name = "l00093" > < / a > 00093 < span class = "comment" > */< / span >
< a name = "l00094" > < / a > < a class = "code" href = "group__data__streams.html#gabef80bcf56e3f5717117f4051c0ca515" > 00094< / a > < span class = "preprocessor" > #define chSequentialStreamWrite(ip, bp, n) ((ip)-> vmt-> write(ip, bp, n))< / span >
< a name = "l00095" > < / a > 00095 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00096" > < / a > 00096 < span class = "comment" > /**< / span >
< a name = "l00097" > < / a > 00097 < span class = "comment" > * @brief Sequential Stream read.< / span >
< a name = "l00098" > < / a > 00098 < span class = "comment" > * @details The function reads data from a stream into a buffer.< / span >
< a name = "l00099" > < / a > 00099 < span class = "comment" > *< / span >
< a name = "l00100" > < / a > 00100 < span class = "comment" > * @param[in] ip pointer to a @p BaseSequentialStream or derived class< / span >
< a name = "l00101" > < / a > 00101 < span class = "comment" > * @param[out] bp pointer to the data buffer< / span >
< a name = "l00102" > < / a > 00102 < span class = "comment" > * @param[in] n the maximum amount of data to be transferred< / span >
< a name = "l00103" > < / a > 00103 < span class = "comment" > * @return The number of bytes transferred. The return value can< / span >
< a name = "l00104" > < / a > 00104 < span class = "comment" > * be less than the specified number of bytes if the< / span >
< a name = "l00105" > < / a > 00105 < span class = "comment" > * stream reaches the end of the available data.< / span >
< a name = "l00106" > < / a > 00106 < span class = "comment" > */< / span >
< a name = "l00107" > < / a > < a class = "code" href = "group__data__streams.html#ga3b78d0032a4346b92c2a60534c322fc5" > 00107< / a > < span class = "preprocessor" > #define chSequentialStreamRead(ip, bp, n) ((ip)-> vmt-> read(ip, bp, n))< / span >
< a name = "l00108" > < / a > 00108 < span class = "preprocessor" > < / span >
< a name = "l00109" > < / a > 00109 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* _CHSTREAMS_H_ */< / span >
< a name = "l00110" > < / a > 00110 < span class = "comment" > < / span >
< a name = "l00111" > < / a > 00111 < span class = "comment" > /** @} */< / span >
< / pre > < / div > < / div >
2010-11-22 05:53:37 +00:00
< / div >
2010-08-10 03:11:02 +00:00
< hr size = "1" > < address style = "text-align: right;" > < small >
2010-11-22 05:53:37 +00:00
Generated on Sun Oct 24 2010 09:40:37 for ChibiOS/RT by < a href = "http://www.doxygen.org/index.html" > < img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.7.1< / small > < / address >
2010-08-10 03:11:02 +00:00
< / body >
< / html >