Skip to content

Commit

Permalink
Refactor variable names from buffer to buf
Browse files Browse the repository at this point in the history
Go encourages short names. And a quick
survey through the Pion code bases reveals,
that we have been using buf more often than buffer.
So this change will harmonize the different spellings.
  • Loading branch information
stv0g committed Nov 13, 2022
1 parent dbb9a44 commit d415139
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 40 deletions.
8 changes: 4 additions & 4 deletions agent.go
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ type Agent struct {
urls []*URL
networkTypes []NetworkType

buffer *packetio.Buffer
buf *packetio.Buffer

// LRU of outbound Binding request Transaction IDs
pendingBindingRequests []bindingRequest
Expand Down Expand Up @@ -205,7 +205,7 @@ func (a *Agent) taskLoop() {
a.deleteAllCandidates()
a.startedFn()

if err := a.buffer.Close(); err != nil {
if err := a.buf.Close(); err != nil {
a.log.Warnf("failed to close buffer: %v", err)
}

Expand Down Expand Up @@ -292,7 +292,7 @@ func NewAgent(config *AgentConfig) (*Agent, error) { //nolint:gocognit
urls: config.Urls,
networkTypes: config.NetworkTypes,
onConnected: make(chan struct{}),
buffer: packetio.NewBuffer(),
buf: packetio.NewBuffer(),
done: make(chan struct{}),
taskLoopDone: make(chan struct{}),
startedCh: startedCtx.Done(),
Expand Down Expand Up @@ -340,7 +340,7 @@ func NewAgent(config *AgentConfig) (*Agent, error) { //nolint:gocognit
// Make sure the buffer doesn't grow indefinitely.
// NOTE: We actually won't get anywhere close to this limit.
// SRTP will constantly read from the endpoint and drop packets if it's full.
a.buffer.SetLimitSize(maxBufferSize)
a.buf.SetLimitSize(maxBufferSize)

if a.lite && (len(a.candidateTypes) != 1 || a.candidateTypes[0] != CandidateTypeHost) {
closeMDNSConn()
Expand Down
10 changes: 5 additions & 5 deletions agent_udpmux_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,18 +66,18 @@ func TestMuxAgent(t *testing.T) {
_, err = conn.Write(data)
require.NoError(t, err)

buffer := make([]byte, 1024)
n, err := muxedConn.Read(buffer)
buf := make([]byte, 1024)
n, err := muxedConn.Read(buf)
require.NoError(t, err)
require.Equal(t, data, buffer[:n])
require.Equal(t, data, buf[:n])

// send a packet from Mux
_, err = muxedConn.Write(data)
require.NoError(t, err)

n, err = conn.Read(buffer)
n, err = conn.Read(buf)
require.NoError(t, err)
require.Equal(t, data, buffer[:n])
require.Equal(t, data, buf[:n])

// close it down
require.NoError(t, conn.Close())
Expand Down
2 changes: 1 addition & 1 deletion candidate_base.go
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ func (c *candidateBase) handleInboundPacket(buf []byte, srcAddr net.Addr) {
}

// Note: This will return packetio.ErrFull if the buffer ever manages to fill up.
if _, err := a.buffer.Write(buf); err != nil {
if _, err := a.buf.Write(buf); err != nil {
a.log.Warnf("Failed to write packet: %s", err)
return
}
Expand Down
8 changes: 4 additions & 4 deletions tcp_mux.go
Original file line number Diff line number Diff line change
Expand Up @@ -403,11 +403,11 @@ func readStreamingPacket(conn net.Conn, buf []byte) (int, error) {
}

func writeStreamingPacket(conn net.Conn, buf []byte) (int, error) {
bufferCopy := make([]byte, streamingPacketHeaderLen+len(buf))
binary.BigEndian.PutUint16(bufferCopy, uint16(len(buf)))
copy(bufferCopy[2:], buf)
bufCopy := make([]byte, streamingPacketHeaderLen+len(buf))
binary.BigEndian.PutUint16(bufCopy, uint16(len(buf)))
copy(bufCopy[2:], buf)

n, err := conn.Write(bufferCopy)
n, err := conn.Write(bufCopy)
if err != nil {
return 0, err
}
Expand Down
18 changes: 9 additions & 9 deletions tcp_packet_conn.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,20 @@ import (

type bufferedConn struct {
net.Conn
buffer *packetio.Buffer
buf *packetio.Buffer
logger logging.LeveledLogger
closed int32
}

func newBufferedConn(conn net.Conn, bufferSize int, logger logging.LeveledLogger) net.Conn {
buffer := packetio.NewBuffer()
if bufferSize > 0 {
buffer.SetLimitSize(bufferSize)
func newBufferedConn(conn net.Conn, bufSize int, logger logging.LeveledLogger) net.Conn {
buf := packetio.NewBuffer()
if bufSize > 0 {
buf.SetLimitSize(bufSize)
}

bc := &bufferedConn{
Conn: conn,
buffer: buffer,
buf: buf,
logger: logger,
}

Expand All @@ -37,7 +37,7 @@ func newBufferedConn(conn net.Conn, bufferSize int, logger logging.LeveledLogger
}

func (bc *bufferedConn) Write(b []byte) (int, error) {
n, err := bc.buffer.Write(b)
n, err := bc.buf.Write(b)
if err != nil {
return n, err
}
Expand All @@ -47,7 +47,7 @@ func (bc *bufferedConn) Write(b []byte) (int, error) {
func (bc *bufferedConn) writeProcess() {
pktBuf := make([]byte, receiveMTU)
for atomic.LoadInt32(&bc.closed) == 0 {
n, err := bc.buffer.Read(pktBuf)
n, err := bc.buf.Read(pktBuf)
if errors.Is(err, io.EOF) {
return
}
Expand All @@ -66,7 +66,7 @@ func (bc *bufferedConn) writeProcess() {

func (bc *bufferedConn) Close() error {
atomic.StoreInt32(&bc.closed, 1)
_ = bc.buffer.Close()
_ = bc.buf.Close()
return bc.Conn.Close()
}

Expand Down
2 changes: 1 addition & 1 deletion transport.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func (c *Conn) Read(p []byte) (int, error) {
return 0, err
}

n, err := c.agent.buffer.Read(p)
n, err := c.agent.buf.Read(p)
atomic.AddUint64(&c.bytesReceived, uint64(n))
return n, err
}
Expand Down
4 changes: 2 additions & 2 deletions udp_mux.go
Original file line number Diff line number Diff line change
Expand Up @@ -338,11 +338,11 @@ func (m *UDPMuxDefault) getConn(ufrag string, isIPv6 bool) (val *udpMuxedConn, o
}

type bufferHolder struct {
buffer []byte
buf []byte
}

func newBufferHolder(size int) *bufferHolder {
return &bufferHolder{
buffer: make([]byte, size),
buf: make([]byte, size),
}
}
28 changes: 14 additions & 14 deletions udp_muxed_conn.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ type udpMuxedConn struct {
addresses []string

// channel holding incoming packets
buffer *packetio.Buffer
buf *packetio.Buffer
closedChan chan struct{}
closeOnce sync.Once
mu sync.Mutex
Expand All @@ -35,7 +35,7 @@ type udpMuxedConn struct {
func newUDPMuxedConn(params *udpMuxedConnParams) *udpMuxedConn {
p := &udpMuxedConn{
params: params,
buffer: packetio.NewBuffer(),
buf: packetio.NewBuffer(),
closedChan: make(chan struct{}),
}

Expand All @@ -47,26 +47,26 @@ func (c *udpMuxedConn) ReadFrom(b []byte) (n int, rAddr net.Addr, err error) {
defer c.params.AddrPool.Put(buf)

// read address
total, err := c.buffer.Read(buf.buffer)
total, err := c.buf.Read(buf.buf)
if err != nil {
return 0, nil, err
}

dataLen := int(binary.LittleEndian.Uint16(buf.buffer[:2]))
dataLen := int(binary.LittleEndian.Uint16(buf.buf[:2]))
if dataLen > total || dataLen > len(b) {
return 0, nil, io.ErrShortBuffer
}

// read data and then address
offset := 2
copy(b, buf.buffer[offset:offset+dataLen])
copy(b, buf.buf[offset:offset+dataLen])
offset += dataLen

// read address len & decode address
addrLen := int(binary.LittleEndian.Uint16(buf.buffer[offset : offset+2]))
addrLen := int(binary.LittleEndian.Uint16(buf.buf[offset : offset+2]))
offset += 2

if rAddr, err = decodeUDPAddr(buf.buffer[offset : offset+addrLen]); err != nil {
if rAddr, err = decodeUDPAddr(buf.buf[offset : offset+addrLen]); err != nil {
return 0, nil, err
}

Expand Down Expand Up @@ -109,7 +109,7 @@ func (c *udpMuxedConn) CloseChannel() <-chan struct{} {
func (c *udpMuxedConn) Close() error {
var err error
c.closeOnce.Do(func() {
err = c.buffer.Close()
err = c.buf.Close()
close(c.closedChan)
})
return err
Expand Down Expand Up @@ -172,28 +172,28 @@ func (c *udpMuxedConn) writePacket(data []byte, addr *net.UDPAddr) error {
defer c.params.AddrPool.Put(buf)

// format of buffer | data len | data bytes | addr len | addr bytes |
if len(buf.buffer) < len(data)+maxAddrSize {
if len(buf.buf) < len(data)+maxAddrSize {
return io.ErrShortBuffer
}
// data len
binary.LittleEndian.PutUint16(buf.buffer, uint16(len(data)))
binary.LittleEndian.PutUint16(buf.buf, uint16(len(data)))
offset := 2

// data
copy(buf.buffer[offset:], data)
copy(buf.buf[offset:], data)
offset += len(data)

// write address first, leaving room for its length
n, err := encodeUDPAddr(addr, buf.buffer[offset+2:])
n, err := encodeUDPAddr(addr, buf.buf[offset+2:])
if err != nil {
return err
}
total := offset + n + 2

// address len
binary.LittleEndian.PutUint16(buf.buffer[offset:], uint16(n))
binary.LittleEndian.PutUint16(buf.buf[offset:], uint16(n))

if _, err := c.buffer.Write(buf.buffer[:total]); err != nil {
if _, err := c.buf.Write(buf.buf[:total]); err != nil {
return err
}
return nil
Expand Down

0 comments on commit d415139

Please sign in to comment.