pgwire

Documentation

Index

• Constants
• func Match(rd io.Reader) bool
• type Server
  • func MakeServer(context *base.Context, executor *sql.Executor, reg *metric.Registry) *Server
  • func (s *Server) IsDraining() bool
  • func (s *Server) Registry() *metric.Registry
  • func (s *Server) ServeConn(conn net.Conn) error
  • func (s *Server) SetDraining(drain bool) error

Constants

const (
	// ErrSSLRequired is returned when a client attempts to connect to a
	// secure server in cleartext.
	ErrSSLRequired = "cleartext connections are not permitted"

	// ErrDraining is returned when a client attempts to connect to a server
	// which is not accepting client connections.
	ErrDraining = "server is not accepting clients"
)

Functions

func Match

func Match(rd io.Reader) bool

Match returns true if rd appears to be a Postgres connection.

Types

type Server

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

Server implements the server side of the PostgreSQL wire protocol.

func MakeServer

func MakeServer(context *base.Context, executor *sql.Executor, reg *metric.Registry) *Server

MakeServer creates a Server, adding network stats to the given Registry.

func (*Server) IsDraining

func (s *Server) IsDraining() bool

IsDraining returns true if the server is not currently accepting connections.

func (*Server) Registry

func (s *Server) Registry() *metric.Registry

Registry returns a registry with the metrics tracked by this server, which can be used to access its stats or be added to another registry.

func (*Server) ServeConn

func (s *Server) ServeConn(conn net.Conn) error

ServeConn serves a single connection, driving the handshake process and delegating to the appropriate connection type.

func (*Server) SetDraining

func (s *Server) SetDraining(drain bool) error

SetDraining (when called with 'true') prevents new connections from being served and waits a reasonable amount of time for open connections to terminate. If an error is returned, the server remains in draining state, though open connections may continue to exist. When called with 'false', switches back to the normal mode of operation in which connections are accepted.