summaryrefslogtreecommitdiff
path: root/txnsync/msgbuffers.go
blob: a531f6da2fc779442ed6bd03b58c02783e7d013e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
// Copyright (C) 2019-2021 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.

package txnsync

import (
	"sync"

	"github.com/algorand/go-algorand/data/transactions"
)

const messageBufferDefaultInitialSize = 10240

// msgBuffersPool holds temporary byte slice buffers used for encoding messages.
var msgBuffersPool = sync.Pool{
	New: func() interface{} {
		return make([]byte, 0, messageBufferDefaultInitialSize)
	},
}

// GetEncodingBuf returns a byte slice that can be used for encoding a
// temporary message.  The byte slice has zero length but potentially
// non-zero capacity.  The caller gets full ownership of the byte slice,
// but is encouraged to return it using releaseMessageBuffer().
func getMessageBuffer() []byte {
	return msgBuffersPool.Get().([]byte)[:0]
}

// releaseMessageBuffer places a byte slice into the pool of temporary buffers
// for encoding.  The caller gives up ownership of the byte slice when
// passing it to releaseMessageBuffer().
func releaseMessageBuffer(s []byte) {
	msgBuffersPool.Put(s) //nolint:staticcheck
}

// txidSlicePool holds temporary byte slice buffers used for encoding messages.
var txidSlicePool = sync.Pool{}

// getTxIDSliceBuffer returns a slice that can be used for storing a
// list of transaction IDs. The slice has zero length but potentially
// non-zero capacity.  The caller gets full ownership of the slice,
// but is encouraged to return it using releaseTxIDSliceBuffer().
func getTxIDSliceBuffer(minSize int) []transactions.Txid {
	alloc := txidSlicePool.Get()
	if alloc == nil {
		return make([]transactions.Txid, 0, minSize)
	}
	buf := alloc.([]transactions.Txid)[:0]
	if cap(buf) >= minSize {
		return buf
	}
	txidSlicePool.Put(alloc)
	return make([]transactions.Txid, 0, minSize)
}

// releaseTxIDSliceBuffer places a slice into the pool of buffers
// for storage.  The caller gives up ownership of the byte slice when
// passing it to releaseMessageBuffer().
func releaseTxIDSliceBuffer(s []transactions.Txid) {
	if cap(s) > 0 {
		txidSlicePool.Put(s) //nolint:staticcheck
	}
}