coap 0.1.0 (latest) · OCaml Package

type t

type buffer =
  (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t

The type of bigarray buffers used to represent message payloads.

Note: This type is compatible with Cstruct buffers.

See: Coap.Message.Coap_core.Message.payload_to_buffer

type kind =

| Confirmable
| Nonconfirmable
| Acknowledgement
| Reset

type code =

| Empty
| Request of [ `Get | `Post | `Put | `Delete ]
| Response of [ `Created | `Deleted | `Valid | `Changed | `Content | `Bad_request | `Unauthorized | `Bad_option | `Forbidden | `Not_found | `Method_not_allowed | `Not_acceptable | `Precondition_failed | `Request_entity_too_large | `Unsupported_content_format | `Internal_server_error | `Not_implemented | `Bad_gateway | `Service_unavailable | `Gateway_timeout | `Proxying_not_supported ]

val pp_code : Format.formatter -> code -> unit

type content_format = [

| `Text of [ `Plain ]
| `Application of [ `Link_format | `Xml | `Octet_stream | `Exi | `Json | `Cbor ]

]

type option =

| If_match of string
| Uri_host of string
| Etag of string
| If_none_match
| Uri_port of int
| Location_path of string
| Uri_path of string
| Content_format of content_format
| Max_age of int
| Uri_query of string
| Accept of int
| Location_query of string
| Proxy_uri of string
| Proxy_scheme of string
| Size1 of int

val make : 
  ?version:int ->
  ?id:int ->
  ?token:string ->
  code:code ->
  ?kind:kind ->
  ?options:option list ->
  ?client_addr:string ->
  buffer ->
  t

Coap message constructor.

val version : t -> int

val id : t -> int

val kind : t -> kind

val code : t -> code

val token : t -> string

Message token used to match a response with a request.

Token values may be 0 to 8 bytes in length.

val options : t -> option list

val path : t -> string list

Extract request path from message options.

val client_addr : t -> string Option.t

val with_client_addr : string Option.t -> t -> t

val payload : t -> buffer

val payload_length : t -> int

val buffer_to_string : buffer -> string

val buffer_of_string : string -> buffer

val is_confirmable : t -> bool

val decode : buffer -> (t, error) result

val encode : t -> buffer

val pp : Format.formatter -> t -> unit

val max_size : int

Maximum safe message size.

https://tools.ietf.org/html/rfc7252#section-4.6

package coap