client

package
Version: v2.3.0-on-1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 16, 2021 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewDeleteRequest

func NewDeleteRequest(ctx context.Context, path string, opts ...message.Option) (*pool.Message, error)

NewDeleteRequest creates delete request.

Use ctx to set timeout.

func NewGetRequest

func NewGetRequest(ctx context.Context, path string, opts ...message.Option) (*pool.Message, error)

NewGetRequest creates get request.

Use ctx to set timeout.

func NewPostRequest

func NewPostRequest(ctx context.Context, path string, contentFormat message.MediaType, payload io.ReadSeeker, opts ...message.Option) (*pool.Message, error)

NewPostRequest creates post request.

Use ctx to set timeout.

An error is returned if by failure to speak COAP (such as a network connectivity problem). Any status code doesn't cause an error.

If payload is nil then content format is not used.

func NewPutRequest

func NewPutRequest(ctx context.Context, path string, contentFormat message.MediaType, payload io.ReadSeeker, opts ...message.Option) (*pool.Message, error)

NewPutRequest creates put request.

Use ctx to set timeout.

If payload is nil then content format is not used.

Types

type Client

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

func NewClient

func NewClient(cc *ClientConn) *Client

func (*Client) ClientConn

func (c *Client) ClientConn() interface{}

ClientConn get's underlaying client connection.

func (*Client) Close

func (c *Client) Close() error

func (*Client) Context

func (c *Client) Context() context.Context

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, path string, opts ...message.Option) (*message.Message, error)

func (*Client) Do

func (c *Client) Do(req *message.Message) (*message.Message, error)

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string, opts ...message.Option) (*message.Message, error)

func (*Client) Observe

func (c *Client) Observe(ctx context.Context, path string, observeFunc func(notification *message.Message), opts ...message.Option) (mux.Observation, error)

func (*Client) Ping

func (c *Client) Ping(ctx context.Context) error

func (*Client) Post

func (c *Client) Post(ctx context.Context, path string, contentFormat message.MediaType, payload io.ReadSeeker, opts ...message.Option) (*message.Message, error)

func (*Client) Put

func (c *Client) Put(ctx context.Context, path string, contentFormat message.MediaType, payload io.ReadSeeker, opts ...message.Option) (*message.Message, error)

func (*Client) RemoteAddr

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

func (*Client) Sequence

func (c *Client) Sequence() uint64

Sequence acquires sequence number.

func (*Client) SetContextValue

func (c *Client) SetContextValue(key interface{}, val interface{})

func (*Client) WriteMessage

func (c *Client) WriteMessage(req *message.Message) error

type ClientConn

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

ClientConn represents a virtual connection to a conceptual endpoint, to perform COAPs commands.

func NewClientConn

func NewClientConn(
	session Session,
	observationTokenHandler *HandlerContainer,
	observationRequests *kitSync.Map,
	transmissionNStart time.Duration,
	transmissionAcknowledgeTimeout time.Duration,
	transmissionMaxRetransmit int,
	handler HandlerFunc,
	blockwiseSZX blockwise.SZX,
	blockWise *blockwise.BlockWise,
	goPool GoPoolFunc,
	errors ErrorFunc,
	getMID GetMIDFunc,
	activityMonitor Notifier,
) *ClientConn

NewClientConn creates connection over session and observation.

func (*ClientConn) AddOnClose

func (cc *ClientConn) AddOnClose(f EventFunc)

AddOnClose calls function on close connection event.

func (*ClientConn) Client

func (cc *ClientConn) Client() *Client

func (*ClientConn) Close

func (cc *ClientConn) Close() error

Close closes connection without wait of ends Run function.

func (*ClientConn) Context

func (cc *ClientConn) Context() context.Context

Context returns the client's context.

If connections was closed context is cancelled.

func (*ClientConn) Delete

func (cc *ClientConn) Delete(ctx context.Context, path string, opts ...message.Option) (*pool.Message, error)

Delete deletes the resource identified by the request path.

Use ctx to set timeout.

func (*ClientConn) Do

func (cc *ClientConn) Do(req *pool.Message) (*pool.Message, error)

Do sends an coap message and returns an coap response.

An error is returned if by failure to speak COAP (such as a network connectivity problem). Any status code doesn't cause an error.

Caller is responsible to release request and response.

func (*ClientConn) Get

func (cc *ClientConn) Get(ctx context.Context, path string, opts ...message.Option) (*pool.Message, error)

Get issues a GET to the specified path.

Use ctx to set timeout.

An error is returned if by failure to speak COAP (such as a network connectivity problem). Any status code doesn't cause an error.

func (*ClientConn) Observe

func (cc *ClientConn) Observe(ctx context.Context, path string, observeFunc func(req *pool.Message), opts ...message.Option) (*Observation, error)

Observe subscribes for every change of resource on path.

func (*ClientConn) Ping

func (cc *ClientConn) Ping(ctx context.Context) error

Ping issues a PING to the client and waits for PONG reponse.

Use ctx to set timeout.

func (*ClientConn) Post

func (cc *ClientConn) Post(ctx context.Context, path string, contentFormat message.MediaType, payload io.ReadSeeker, opts ...message.Option) (*pool.Message, error)

Post issues a POST to the specified path.

Use ctx to set timeout.

An error is returned if by failure to speak COAP (such as a network connectivity problem). Any status code doesn't cause an error.

If payload is nil then content format is not used.

func (*ClientConn) Process

func (cc *ClientConn) Process(datagram []byte) error

func (*ClientConn) Put

func (cc *ClientConn) Put(ctx context.Context, path string, contentFormat message.MediaType, payload io.ReadSeeker, opts ...message.Option) (*pool.Message, error)

Put issues a PUT to the specified path.

Use ctx to set timeout.

An error is returned if by failure to speak COAP (such as a network connectivity problem). Any status code doesn't cause an error.

If payload is nil then content format is not used.

func (*ClientConn) RemoteAddr

func (cc *ClientConn) RemoteAddr() net.Addr

func (*ClientConn) Run

func (cc *ClientConn) Run() error

Run reads and process requests from a connection, until the connection is closed.

func (*ClientConn) Sequence

func (cc *ClientConn) Sequence() uint64

Sequence acquires sequence number.

func (*ClientConn) Session

func (cc *ClientConn) Session() Session

func (*ClientConn) SetContextValue

func (cc *ClientConn) SetContextValue(key interface{}, val interface{})

SetContextValue stores the value associated with key to context of connection.

func (*ClientConn) Transmission

func (cc *ClientConn) Transmission() *Transmission

func (*ClientConn) WriteMessage

func (cc *ClientConn) WriteMessage(req *pool.Message) error

WriteMessage sends an coap message.

type ErrorFunc

type ErrorFunc = func(error)

type EventFunc

type EventFunc = func()

type GetMIDFunc

type GetMIDFunc = func() uint16

type GoPoolFunc

type GoPoolFunc = func(func()) error

type HandlerContainer

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

HandlerContainer for regirstration handlers by key

func NewHandlerContainer

func NewHandlerContainer() *HandlerContainer

NewHandlerContainer factory

func (*HandlerContainer) Get

func (s *HandlerContainer) Get(key interface{}) (HandlerFunc, error)

Get returns handler for key

func (*HandlerContainer) Insert

func (s *HandlerContainer) Insert(key interface{}, handler HandlerFunc) error

Insert handler for key.

func (*HandlerContainer) Pop

func (s *HandlerContainer) Pop(key interface{}) (HandlerFunc, error)

Pop pops handler for key

type HandlerFunc

type HandlerFunc = func(*ResponseWriter, *pool.Message)

func HandlerFuncToMux

func HandlerFuncToMux(m mux.Handler) HandlerFunc

func NewObservationHandler

func NewObservationHandler(obsertionTokenHandler *HandlerContainer, next HandlerFunc) HandlerFunc

type MutexMap

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

MutexMap wraps a map of mutexes. Each key locks separately.

func NewMutexMap

func NewMutexMap() *MutexMap

NewMutexMap returns an initalized MutexMap.

func (*MutexMap) Lock

func (m *MutexMap) Lock(key interface{}) Unlocker

Lock acquires a lock corresponding to this key. This method will never return nil and Unlock() must be called to release the lock when done.

type Notifier

type Notifier interface {
	Notify()
}

type Observation

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

Observation represents subscription to resource on the server

func (*Observation) Cancel

func (o *Observation) Cancel(ctx context.Context) error

Cancel remove observation from server. For recreate observation use Observe.

type ResponseWriter

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

A ResponseWriter interface is used by an COAP handler to construct an COAP response.

func NewResponseWriter

func NewResponseWriter(response *pool.Message, cc *ClientConn, requestOptions message.Options) *ResponseWriter

func (*ResponseWriter) ClientConn

func (r *ResponseWriter) ClientConn() *ClientConn

func (*ResponseWriter) SendReset

func (r *ResponseWriter) SendReset()

func (*ResponseWriter) SetResponse

func (r *ResponseWriter) SetResponse(code codes.Code, contentFormat message.MediaType, d io.ReadSeeker, opts ...message.Option) error

type Session

type Session interface {
	Context() context.Context
	Close() error
	MaxMessageSize() int
	RemoteAddr() net.Addr
	WriteMessage(req *pool.Message) error
	Run(cc *ClientConn) error
	AddOnClose(f EventFunc)
	SetContextValue(key interface{}, val interface{})
}

type Transmission

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

Transmission is a threadsafe container for transmission related parameters

func (*Transmission) SetTransmissionAcknowledgeTimeout

func (t *Transmission) SetTransmissionAcknowledgeTimeout(d time.Duration)

func (*Transmission) SetTransmissionMaxRetransmit

func (t *Transmission) SetTransmissionMaxRetransmit(d int32)

func (*Transmission) SetTransmissionNStart

func (t *Transmission) SetTransmissionNStart(d time.Duration)

type Unlocker

type Unlocker interface {
	Unlock()
}

Unlocker provides an Unlock method to release the lock.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to