renaming: AcquireByteBuffer -> Acquire, ReleaseByteBuffer -> Release

This commit is contained in:
Aliaksandr Valialkin
2016-06-23 11:07:55 +03:00
parent e8ad8e40ca
commit 164e50ac3f
4 changed files with 12 additions and 12 deletions
+6 -6
View File
@@ -6,7 +6,7 @@ package bytebufferpool
// ByteBuffer may be used with functions appending data to the given []byte
// slice. See example code for details.
//
// Use AcquireByteBuffer for obtaining an empty byte buffer.
// Use Acquire for obtaining an empty byte buffer.
type ByteBuffer struct {
// B is a byte buffer to use in append-like workloads.
@@ -41,20 +41,20 @@ func (b *ByteBuffer) Reset() {
b.B = b.B[:0]
}
// AcquireByteBuffer returns an empty byte buffer from the pool.
// Acquire returns an empty byte buffer from the pool.
//
// Acquired byte buffer may be returned to the pool via ReleaseByteBuffer call.
// Acquired byte buffer may be returned to the pool via Release call.
// This reduces the number of memory allocations required for byte buffer
// management.
func AcquireByteBuffer() *ByteBuffer {
func Acquire() *ByteBuffer {
return defaultByteBufferPool.Acquire()
}
// ReleaseByteBuffer returns byte buffer to the pool.
// Release returns byte buffer to the pool.
//
// ByteBuffer.B mustn't be touched after returning it to the pool.
// Otherwise data races will occur.
func ReleaseByteBuffer(b *ByteBuffer) {
func Release(b *ByteBuffer) {
defaultByteBufferPool.Release(b)
}
+2 -2
View File
@@ -7,7 +7,7 @@ import (
)
func ExampleByteBuffer() {
bb := bytebufferpool.AcquireByteBuffer()
bb := bytebufferpool.Acquire()
bb.WriteString("first line\n")
bb.Write([]byte("second line\n"))
@@ -17,5 +17,5 @@ func ExampleByteBuffer() {
// It is safe to release byte buffer now, since it is
// no longer used.
bytebufferpool.ReleaseByteBuffer(bb)
bytebufferpool.Release(bb)
}
+2 -2
View File
@@ -32,12 +32,12 @@ func TestByteBufferAcquireReleaseConcurrent(t *testing.T) {
func testByteBufferAcquireRelease(t *testing.T) {
for i := 0; i < 10; i++ {
expectedS := fmt.Sprintf("num %d", i)
b := AcquireByteBuffer()
b := Acquire()
b.B = append(b.B, "num "...)
b.B = append(b.B, fmt.Sprintf("%d", i)...)
if string(b.B) != expectedS {
t.Fatalf("unexpected result: %q. Expecting %q", b.B, expectedS)
}
ReleaseByteBuffer(b)
Release(b)
}
}
+2 -2
View File
@@ -42,12 +42,12 @@ func testPoolVariousSizes(t *testing.T) {
}
func testAcquireRelease(t *testing.T, n int) {
bb := AcquireByteBuffer()
bb := Acquire()
if len(bb.B) > 0 {
t.Fatalf("non-empty byte buffer returned from acquire")
}
bb.B = allocNBytes(bb.B, n)
ReleaseByteBuffer(bb)
Release(bb)
}
func allocNBytes(dst []byte, n int) []byte {