logconn

Documentation

Index

• type LogConn
  • func NewLogConn(le *logrus.Entry, underlying net.Conn) *LogConn
  • func (c *LogConn) Close() error
  • func (c *LogConn) LocalAddr() net.Addr
  • func (c *LogConn) Read(b []byte) (n int, err error)
  • func (c *LogConn) RemoteAddr() net.Addr
  • func (c *LogConn) SetDeadline(t time.Time) error
  • func (c *LogConn) SetReadDeadline(t time.Time) error
  • func (c *LogConn) SetWriteDeadline(t time.Time) error
  • func (c *LogConn) Write(b []byte) (n int, err error)

Types

type LogConn

type LogConn struct {
	// contains filtered or unexported fields
}

LogConn wraps a net.Conn with a logger.

func NewLogConn

func NewLogConn(le *logrus.Entry, underlying net.Conn) *LogConn

func (*LogConn) Close

func (c *LogConn) Close() error

Close closes the connection. Any blocked Read or Write operations will be unblocked and return errors.

func (*LogConn) LocalAddr

func (c *LogConn) LocalAddr() net.Addr

LocalAddr returns the local network address.

func (*LogConn) Read

func (c *LogConn) Read(b []byte) (n int, err error)

Read reads data from the connection. Read can be made to time out and return an error after a fixed time limit; see SetDeadline and SetReadDeadline.

func (*LogConn) RemoteAddr

func (c *LogConn) RemoteAddr() net.Addr

RemoteAddr returns the remote network address.

func (*LogConn) SetDeadline

func (c *LogConn) SetDeadline(t time.Time) error

SetDeadline sets the read and write deadlines associated with the connection. It is equivalent to calling both SetReadDeadline and SetWriteDeadline.

A deadline is an absolute time after which I/O operations fail instead of blocking. The deadline applies to all future and pending I/O, not just the immediately following call to Read or Write. After a deadline has been exceeded, the connection can be refreshed by setting a deadline in the future.

If the deadline is exceeded a call to Read or Write or to other I/O methods will return an error that wraps os.ErrDeadlineExceeded. This can be tested using errors.Is(err, os.ErrDeadlineExceeded). The error's Timeout method will return true, but note that there are other possible errors for which the Timeout method will return true even if the deadline has not been exceeded.

An idle timeout can be implemented by repeatedly extending the deadline after successful Read or Write calls.

A zero value for t means I/O operations will not time out.

func (*LogConn) SetReadDeadline

func (c *LogConn) SetReadDeadline(t time.Time) error

SetReadDeadline sets the deadline for future Read calls and any currently-blocked Read call. A zero value for t means Read will not time out.

func (*LogConn) SetWriteDeadline

func (c *LogConn) SetWriteDeadline(t time.Time) error

SetWriteDeadline sets the deadline for future Write calls and any currently-blocked Write call. Even if write times out, it may return n > 0, indicating that some of the data was successfully written. A zero value for t means Write will not time out.

func (*LogConn) Write

func (c *LogConn) Write(b []byte) (n int, err error)

Write writes data to the connection. Write can be made to time out and return an error after a fixed time limit; see SetDeadline and SetWriteDeadline.