mtls

Documentation

Index

• Variables
• func MtlsConnect(address string, port uint16) (*tls.Conn, error)
• func ReadEnvelope(connection *tls.Conn) (*pb.Envelope, error)
• func WriteEnvelope(connection *tls.Conn, envelope *pb.Envelope) error
• func WritePing(connection *tls.Conn) error

Variables

var (
	// PingInterval - Amount of time between in-band "pings"
	PingInterval = 2 * time.Minute
)

Functions

func MtlsConnect

func MtlsConnect(address string, port uint16) (*tls.Conn, error)

MtlsConnect - Get a TLS connection or die trying

func ReadEnvelope

func ReadEnvelope(connection *tls.Conn) (*pb.Envelope, error)

ReadEnvelope - Reads a message from the TLS connection using length prefix framing

func WriteEnvelope

func WriteEnvelope(connection *tls.Conn, envelope *pb.Envelope) error

WriteEnvelope - Writes a message to the TLS socket using length prefix framing which is a fancy way of saying we write the length of the message then the message e.g. [uint32 length|message] so the receiver can delimit messages properly

func WritePing

func WritePing(connection *tls.Conn) error

WritePing - Send a "ping" message to the server