GoldenGateBindings / com.fitbit.goldengate.bindings.coap.data

Package com.fitbit.goldengate.bindings.coap.data

Types

AcceptOption

data class AcceptOption : Option

Can be used to indicate which Content-Format is acceptable to the client.

BaseOutgoingMessageBuilder

abstract class BaseOutgoingMessageBuilder<T : Message> : OutgoingMessageBuilder<T>

Base class for MessageBuilder providing common implementation

BaseRequest

interface BaseRequest

Holds common data for IncomingRequest and OutgoingRequest

BaseResponse

interface BaseResponse

Holds common data for IncomingResponse and OutgoingResponse

BytesArrayOutgoingBody

class BytesArrayOutgoingBody : OutgoingBody

OutgoingBody with body source from a ByteArray

ContentFormatOption

data class ContentFormatOption : Option

The Content-Format Option indicates the representation format of the message payload.

EmptyOptionValue

class EmptyOptionValue : OptionValue

For option that does not have a value, like OptionNumber.IF_NONE_MATCH

EmptyOutgoingBody

class EmptyOutgoingBody : OutgoingBody

Empty OutgoingBody

EtagOption

data class EtagOption : Option

The request MAY include one or more ETag Options, identifying responses that the client has stored.

ExtendedError

data class ExtendedError

FormatOptionValue

enum class FormatOptionValue

The Content-Format Option indicates the representation format of the message payload. These are the supported value for ContentFormatOption and AcceptOption coap options

IfMatchOption

data class IfMatchOption : Option

The If-Match Option MAY be used to make a request conditional on the current existence or value of an ETag for one or more representations of the target resource.

IfNoneMatchOption

object IfNoneMatchOption : Option

The If-None-Match Option MAY be used to make a request conditional on the nonexistence of the target resource.

IncomingBody

interface IncomingBody

Represents the body of a incoming coap message.

IncomingMessage

interface IncomingMessage : Message

This interface represents incoming CoAP Message objects.

IncomingRequest

interface IncomingRequest : IncomingMessage, BaseRequest

Incoming coap request message.

IncomingResponse

interface IncomingResponse : IncomingMessage, BaseResponse

Incoming coap response message.

InputStreamOutgoingBody

class InputStreamOutgoingBody : OutgoingBody

OutgoingBody with body source from a InputStream

IntOptionValue

data class IntOptionValue : OptionValue

Option value with Int type

LocationPathOption

data class LocationPathOption : Option

The values of these options specify the location at which the resource was created. Otherwise, the resource was created at the request URI.

LocationQueryOption

data class LocationQueryOption : Option

The values of these options specify the location at which the resource was created. Otherwise, the resource was created at the request URI.

MaxAgeOption

data class MaxAgeOption : Option

Caches can use the Max-Age Option to determine freshness and (if present) the ETAG Option for validation

Message

interface Message

This interface represents CoAP message objects.

Method

enum class Method

Supported Coap methods. These are analogous to HTTP methods of the same names.

OpaqueOptionValue

class OpaqueOptionValue : OptionValue

Option value with Opaque type

Option

sealed class Option

Individual Coap option

OptionNumber

enum class OptionNumber

Supported options that can be added to a coap message options

OptionValue

sealed class OptionValue

Supported value types for a coap option

OutgoingBody

sealed class OutgoingBody

Represents body of outgoing coap message.

OutgoingMessage

interface OutgoingMessage : Message

This interface represents outgoing CoAP Message objects.

OutgoingMessageBuilder

interface OutgoingMessageBuilder<T : Message>

A MessageBuilder is used for constructing Message objects. This interface contains the shared components of OutgoingRequestBuilder and OutgoingResponseBuilder

OutgoingRequest

interface OutgoingRequest : OutgoingMessage, BaseRequest

Represents outgoing request for a request in coap client mode.

OutgoingRequestBuilder

class OutgoingRequestBuilder : BaseOutgoingMessageBuilder<OutgoingRequest>

Concrete class of MessageBuilder for building OutgoingRequest

OutgoingResponse

interface OutgoingResponse : OutgoingMessage, BaseResponse

Implementations of this interface will be sent back to the CoAP Client in response to requests coming in to a CoAP Server

OutgoingResponseBuilder

class OutgoingResponseBuilder : BaseOutgoingMessageBuilder<OutgoingResponse>

Concrete class of MessageBuilder for building OutgoingResponse

ResponseCode

data class ResponseCode

This represents a CoAP response code (analogous to an HTTP response code (e.g. 201, 404, 500)

StartOffset

data class StartOffset : Option

Vendor(Fitbit) option for start offset in a file

StringOptionValue

data class StringOptionValue : OptionValue

Option value with String type

UriQueryOption

data class UriQueryOption : Option

Specifies one argument parameterizing the resource.

Type Aliases

Data

typealias Data = ByteArray

Opaque

typealias Opaque = ByteArray

Options

typealias Options = LinkedList<Option>

Functions

clientError

fun ResponseCode.clientError(): Boolean

Extension function that return true if response is client error, false otherwise

error

fun ResponseCode.error(): Boolean

Extension function that return true if response is client or server error, false otherwise

ok

fun ResponseCode.ok(): Boolean

Extension function that return true if response is ok, false otherwise

serverError

fun ResponseCode.serverError(): Boolean

Extension function that return true if response is server error, false otherwise