Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

ncp

package module

Go to main page

Versions in this module

v1

v1.0.5

Feb 20, 2023

Changes in this version

+ var ErrConnNotFound = NewGenericError("connection not found", false, false)

v1.0.4

Jan 31, 2023

v1.0.3

Oct 17, 2020

v1.0.2

Aug 3, 2020

Changes in this version

+ var ErrConnClosed = NewGenericError("connection closed", false, false)

v1.0.1

Jul 12, 2020

v1.0.0

Apr 6, 2020

Changes in this version

+ const MinSequenceID

+ var DefaultConfig = Config

+ var ErrBufferSizeTooSmall = NewGenericError("read buffer size is less than data length in non-stream mode", false, true)

+ var ErrDataSizeTooLarge = NewGenericError("data size is greater than session mtu", false, true)

+ var ErrInvalidPacket = NewGenericError("invalid packet", false, true)

+ var ErrNotHandshake = NewGenericError("first packet is not handshake packet", false, true)

+ var ErrReadDeadlineExceeded = NewGenericError("read deadline exceeded", true, true)

+ var ErrRecvWindowFull = NewGenericError("receive window full", false, true)

+ var ErrSessionClosed = NewGenericError("session closed", false, false)

+ var ErrSessionEstablished = NewGenericError("session is already established", false, false)

+ var ErrSessionNotEstablished = NewGenericError("session not established yet", false, true)

+ var ErrWriteDeadlineExceeded = NewGenericError("write deadline exceeded", true, true)

+ func CompareSeq(seq1, seq2 uint32) int

+ func NextSeq(seq uint32, step int64) uint32

+ func SeqInBetween(startSeq, endSeq, targetSeq uint32) bool

+ type Config struct

+ CheckBytesReadInterval int32

+ CheckTimeoutInterval int32

+ FlushInterval int32

+ InitialConnectionWindowSize int32

+ InitialRetransmissionTimeout int32

+ Linger int32

+ MTU int32

+ MaxAckSeqListSize int32

+ MaxConnectionWindowSize int32

+ MaxRetransmissionTimeout int32

+ MinConnectionWindowSize int32

+ NonStream bool

+ SendAckInterval int32

+ SendBytesReadThreshold int32

+ SessionWindowSize int32

+ func MergeConfig(conf *Config) (*Config, error)

+ type Connection struct

+ func NewConnection(session *Session, localClientID, remoteClientID string) (*Connection, error)

+ func (conn *Connection) ReceiveAck(sequenceID uint32, isSentByMe bool)

+ func (conn *Connection) RetransmissionTimeout() time.Duration

+ func (conn *Connection) SendAck(sequenceID uint32)

+ func (conn *Connection) SendAckQueueLen() int

+ func (conn *Connection) SendWindowUsed() uint32

+ func (conn *Connection) Start()

+ type GenericError struct

+ func NewGenericError(err string, timeout, temporary bool) *GenericError

+ func (e GenericError) Error() string

+ func (e GenericError) Temporary() bool

+ func (e GenericError) Timeout() bool

+ type SendWithFunc func(localClientID, remoteClientID string, buf []byte, writeTimeout time.Duration) error

+ type SeqHeap []uint32

+ func (h *SeqHeap) Pop() interface{}

+ func (h *SeqHeap) Push(x interface{})

+ func (h SeqHeap) Len() int

+ func (h SeqHeap) Less(i, j int) bool

+ func (h SeqHeap) Swap(i, j int)

+ type Session struct

+ func NewSession(localAddr, remoteAddr net.Addr, localClientIDs, remoteClientIDs []string, ...) (*Session, error)

+ func (session *Session) Accept() error

+ func (session *Session) Close() error

+ func (session *Session) Dial(ctx context.Context) error

+ func (session *Session) GetBytesRead() uint64

+ func (session *Session) GetConnWindowSize() uint32

+ func (session *Session) GetDataToSend(sequenceID uint32) []byte

+ func (session *Session) IsClosed() bool

+ func (session *Session) IsEstablished() bool

+ func (session *Session) IsStream() bool

+ func (session *Session) LocalAddr() net.Addr

+ func (session *Session) Read(b []byte) (_ int, e error)

+ func (session *Session) ReceiveWith(localClientID, remoteClientID string, buf []byte) error

+ func (session *Session) RecvWindowUsed() uint32

+ func (session *Session) RemoteAddr() net.Addr

+ func (session *Session) SendWindowUsed() uint32

+ func (session *Session) SetDeadline(t time.Time) error

+ func (session *Session) SetLinger(t int32)

+ func (session *Session) SetReadDeadline(t time.Time) error

+ func (session *Session) SetWriteDeadline(t time.Time) error

+ func (session *Session) Write(b []byte) (_ int, e error)