mirror
/
av
mirror of https://bitbucket.org/ausocean/av.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improved function description

This commit is contained in:
Saxon1 2017-12-04 12:57:35 +10:30
parent 4783f39400
commit 13c6bd531b
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
ringbuffer/RingBuffer.go
View File

@ -120,11 +120,11 @@ func (rb *ringBuffer) DoneWriting(size int) error {
} }
/* /*
Read gets the address of the next element that we would like to get data Read returns a slice containing the next element in the ring buffer and
from and thereafter consider empty in the buffer for writing during latter thereafter considers it empty and can be used for latter writing. The address
calls to Get. The address of the data is returned, as well as the size of of the data is returned, as well as the size of the data contained at this
the data contained at this address. An error is returned if the buffer is address. An error is returned if the buffer is empty, or there has been a
empty, or there has been a second call to Read before a call to DoneReading. second call to Read before a call to DoneReading.
*/ */
func (rb *ringBuffer) Read() ([]byte, error) { func (rb *ringBuffer) Read() ([]byte, error) {
rb.mutex.Lock() rb.mutex.Lock()