2014-02-20 20:09:24 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< title > libpcp: _pcp_buffer Struct Reference< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > libpcp
  < span id = "projectnumber" > 0.2.1< / span >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li class = "current" > < a href = "annotated.html" > < span > Classes< / span > < / a > < / li >
< li > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
< div id = "navrow2" class = "tabs2" >
< ul class = "tablist" >
< li > < a href = "annotated.html" > < span > Class  List< / span > < / a > < / li >
< li > < a href = "functions.html" > < span > Class  Members< / span > < / a > < / li >
< / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "summary" >
< a href = "#pub-attribs" > Public Attributes< / a > |
< a href = "struct__pcp__buffer-members.html" > List of all members< / a > < / div >
< div class = "headertitle" >
< div class = "title" > _pcp_buffer Struct Reference< div class = "ingroups" > < a class = "el" href = "group__Buffer.html" > BUFFER< / a > < / div > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > A flexible buffer object wich automatically resizes, if neccessary.
< a href = "struct__pcp__buffer.html#details" > More...< / a > < / p >
< p > < code > #include < < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > > < / code > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-attribs" > < / a >
Public Attributes< / h2 > < / td > < / tr >
< tr class = "memitem:aa45619703bed4597d1ac7a45c40b92e3" > < td class = "memItemLeft" align = "right" valign = "top" > char *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct__pcp__buffer.html#aa45619703bed4597d1ac7a45c40b92e3" > name< / a > < / td > < / tr >
< tr class = "memdesc:aa45619703bed4597d1ac7a45c40b92e3" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > just for convenience in error messages and the like, so we know which buffer cause trouble < a href = "#aa45619703bed4597d1ac7a45c40b92e3" > < / a > < br / > < / td > < / tr >
< tr class = "separator:aa45619703bed4597d1ac7a45c40b92e3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a48fee003c319d92f8d9a5e4c2c735e6f" > < td class = "memItemLeft" align = "right" valign = "top" > uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct__pcp__buffer.html#a48fee003c319d92f8d9a5e4c2c735e6f" > allocated< / a > < / td > < / tr >
< tr class = "memdesc:a48fee003c319d92f8d9a5e4c2c735e6f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > marks the buffer as allocated < a href = "#a48fee003c319d92f8d9a5e4c2c735e6f" > < / a > < br / > < / td > < / tr >
< tr class = "separator:a48fee003c319d92f8d9a5e4c2c735e6f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7fdd9e4a9ed7abfc5eec36cb1eca281a" > < td class = "memItemLeft" align = "right" valign = "top" > size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct__pcp__buffer.html#a7fdd9e4a9ed7abfc5eec36cb1eca281a" > blocksize< / a > < / td > < / tr >
< tr class = "memdesc:a7fdd9e4a9ed7abfc5eec36cb1eca281a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > the blocksize to use when resizing, also used for initial malloc() < a href = "#a7fdd9e4a9ed7abfc5eec36cb1eca281a" > < / a > < br / > < / td > < / tr >
< tr class = "separator:a7fdd9e4a9ed7abfc5eec36cb1eca281a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a8bf9eb28e7fa878847212133ece0c482" > < td class = "memItemLeft" align = "right" valign = "top" > size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct__pcp__buffer.html#a8bf9eb28e7fa878847212133ece0c482" > size< / a > < / td > < / tr >
< tr class = "memdesc:a8bf9eb28e7fa878847212133ece0c482" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > stores the current allocated size of the object < a href = "#a8bf9eb28e7fa878847212133ece0c482" > < / a > < br / > < / td > < / tr >
< tr class = "separator:a8bf9eb28e7fa878847212133ece0c482" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a0ea19798e2cd04c152980bd7caac5d10" > < td class = "memItemLeft" align = "right" valign = "top" > size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct__pcp__buffer.html#a0ea19798e2cd04c152980bd7caac5d10" > offset< / a > < / td > < / tr >
< tr class = "memdesc:a0ea19798e2cd04c152980bd7caac5d10" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > current read position < a href = "#a0ea19798e2cd04c152980bd7caac5d10" > < / a > < br / > < / td > < / tr >
< tr class = "separator:a0ea19798e2cd04c152980bd7caac5d10" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:acad944641be2d2e4c4109f83b6a6609f" > < td class = "memItemLeft" align = "right" valign = "top" > size_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct__pcp__buffer.html#acad944641be2d2e4c4109f83b6a6609f" > end< / a > < / td > < / tr >
< tr class = "memdesc:acad944641be2d2e4c4109f83b6a6609f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > current write position, data end. < a href = "#acad944641be2d2e4c4109f83b6a6609f" > < / a > < br / > < / td > < / tr >
< tr class = "separator:acad944641be2d2e4c4109f83b6a6609f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa1e4c60e982f39498ce66af85325bab6" > < td class = "memItemLeft" align = "right" valign = "top" > uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct__pcp__buffer.html#aa1e4c60e982f39498ce66af85325bab6" > isstring< / a > < / td > < / tr >
< tr class = "memdesc:aa1e4c60e982f39498ce66af85325bab6" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > treat as char array/string < a href = "#aa1e4c60e982f39498ce66af85325bab6" > < / a > < br / > < / td > < / tr >
< tr class = "separator:aa1e4c60e982f39498ce66af85325bab6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a8d80e52785446bcc9e2fd4456c97daf5" > < td class = "memItemLeft" align = "right" valign = "top" > void *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "struct__pcp__buffer.html#a8d80e52785446bcc9e2fd4456c97daf5" > buf< / a > < / td > < / tr >
< tr class = "memdesc:a8d80e52785446bcc9e2fd4456c97daf5" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > the actual storage buffer < a href = "#a8d80e52785446bcc9e2fd4456c97daf5" > < / a > < br / > < / td > < / tr >
< tr class = "separator:a8d80e52785446bcc9e2fd4456c97daf5" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< div class = "textblock" > < p > A flexible buffer object wich automatically resizes, if neccessary. < / p >
< p > Definition at line < a class = "el" href = "buffer_8h_source.html#l00050" > 50< / a > of file < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > .< / p >
< / div > < h2 class = "groupheader" > Member Data Documentation< / h2 >
< a class = "anchor" id = "a48fee003c319d92f8d9a5e4c2c735e6f" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint8_t _pcp_buffer::allocated< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > marks the buffer as allocated < / p >
< p > Definition at line < a class = "el" href = "buffer_8h_source.html#l00052" > 52< / a > of file < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a7fdd9e4a9ed7abfc5eec36cb1eca281a" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > size_t _pcp_buffer::blocksize< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > the blocksize to use when resizing, also used for initial malloc() < / p >
< p > Definition at line < a class = "el" href = "buffer_8h_source.html#l00053" > 53< / a > of file < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a8d80e52785446bcc9e2fd4456c97daf5" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void* _pcp_buffer::buf< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > the actual storage buffer < / p >
< p > Definition at line < a class = "el" href = "buffer_8h_source.html#l00058" > 58< / a > of file < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "acad944641be2d2e4c4109f83b6a6609f" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > size_t _pcp_buffer::end< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > current write position, data end. < / p >
< p > maybe less than size. < / p >
< p > Definition at line < a class = "el" href = "buffer_8h_source.html#l00056" > 56< / a > of file < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "aa1e4c60e982f39498ce66af85325bab6" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > uint8_t _pcp_buffer::isstring< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > treat as char array/string < / p >
< p > Definition at line < a class = "el" href = "buffer_8h_source.html#l00057" > 57< / a > of file < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "aa45619703bed4597d1ac7a45c40b92e3" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > char* _pcp_buffer::name< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > just for convenience in error messages and the like, so we know which buffer cause trouble < / p >
< p > Definition at line < a class = "el" href = "buffer_8h_source.html#l00051" > 51< / a > of file < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a0ea19798e2cd04c152980bd7caac5d10" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > size_t _pcp_buffer::offset< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > current read position < / p >
< p > Definition at line < a class = "el" href = "buffer_8h_source.html#l00055" > 55< / a > of file < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > .< / p >
< / div >
< / div >
< a class = "anchor" id = "a8bf9eb28e7fa878847212133ece0c482" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > size_t _pcp_buffer::size< / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > stores the current allocated size of the object < / p >
< p > Definition at line < a class = "el" href = "buffer_8h_source.html#l00054" > 54< / a > of file < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this struct was generated from the following file:< ul >
< li > < a class = "el" href = "buffer_8h_source.html" > buffer.h< / a > < / li >
< / ul >
< / div > <!-- contents -->
<!-- start footer part -->
< hr class = "footer" / > < address class = "footer" > < small >
2014-02-20 21:02:52 +01:00
Generated on Thu Feb 20 2014 20:58:12 for libpcp by   < a href = "http://www.doxygen.org/index.html" >
2014-02-20 20:09:24 +01:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.2
< / small > < / address >
< / body >
< / html >
