~ubuntu-branches/ubuntu/precise/nordugrid-arc/precise

« back to all changes in this revision

Viewing changes to src/hed/libs/data/DataBuffer.h

  • Committer: Package Import Robot
  • Author(s): Mattias Ellert
  • Date: 2012-03-01 19:48:16 UTC
  • mfrom: (3.1.5 sid)
  • Revision ID: package-import@ubuntu.com-20120301194816-m1ezrwnwt2qgnc2e
Tags: 1.1.1-1
* 1.1.1 Bugfix Release
* Fixes FTBFS (Closes: #661774) (LP: #935007)
* Fix typo in package description (Closes: #646979)
* Split binary rule in debian/rules for arch and indep

Show diffs side-by-side

added added

removed removed

Lines of Context:
108
108
    /// \param wait if true and there are no free buffers, method will wait
109
109
    /// for one.
110
110
    /// \return true on success
 
111
    /// For python bindings pattern of this method is
 
112
    /// (bool, handle, length) for_read(wait). Here buffer for reading
 
113
    /// to be provided by external code and provided to DataBuffer
 
114
    /// object through is_read() method. Content of buffer must not exceed
 
115
    /// provided length.
111
116
    bool for_read(int& handle, unsigned int& length, bool wait);
112
117
    /// Check if there are buffers which can be taken by for_read(). This
113
118
    /// function checks only for buffers and does not take eof and error
117
122
    /// \param handle buffer's number.
118
123
    /// \param length amount of data.
119
124
    /// \param offset offset in stream, file, etc.
 
125
    /// For python bindings pattern of that method is 
 
126
    /// bool is_read(handle,buffer,offset). Here buffer is 
 
127
    /// string containing content of buffer to be passed to
 
128
    /// DataBuffer object.
120
129
    bool is_read(int handle, unsigned int length,
121
130
                 unsigned long long int offset);
122
131
    /// Informs object that data was read into buffer.
130
139
    /// \param length returns size of buffer
131
140
    /// \param wait if true and there are no free buffers, method will wait
132
141
    /// for one.
 
142
    /// For python bindings pattern of this method is
 
143
    /// (bool, handle, length, offset, buffer) for_write(wait).
 
144
    /// Here buffer is string with content of buffer provided
 
145
    /// by DataBuffer object; 
133
146
    bool for_write(int& handle, unsigned int& length,
134
147
                   unsigned long long int& offset, bool wait);
135
148
    /// Check if there are buffers which can be taken by for_write(). This