Provider - CoAP

Description - A CoAP Client Provider initializes a Constrained Application Protocol client to manage the message exchanges with CoAP servers.

Runtime Class - com.iwaysoftware.eclipse.template.CoAPClientProviderType

Parameter Groups

	Parameter	Type	Description
*	Protocol Scheme	string	Choose the protocol scheme. coap uses UDP, coaps uses DTLS, coap+tcp uses TCP, coaps+tcp uses TCP with TLS. Select from one of the following options: coap {coap} coaps {coaps} coap+tcp {coap+tcp} coaps+tcp {coaps+tcp}
	Local Bind Address	string	Local bind address for multi-homed hosts: usually leave empty
	Maximum Peers	integer	The maximum number of active peers supported. An active peer is a node with which we exchange CoAP messages.
	Maximum Inactivity Period	integer	The maximum number of seconds a peer may be inactive before it is considered stale and all state associated with it can be discarded.
	Acknowledgement Timeout	integer	Minimum spacing in milliseconds before another retransmission. This parameter is called ACK_TIMEOUT in the RFC.
	Acknowledgement Random Factor	decimal	A floating point factor greater than 1.0 used to compute the upper bound for the acknowledgement timeout. This parameter is called ACK_RANDOM_FACTOR in the RFC. The initial timeout is set to a random duration between ACK_TIMEOUT and (ACK_TIMEOUT * ACK_RANDOM_FACTOR).
	Maximum Retransmissions	integer	Sets the maximum number of times a flight of handshake messages gets re-transmitted to a peer.
	Exchange Lifetime	integer	The time in milliseconds from starting to send a Confirmable message to the time when an acknowledgement is no longer expected. This parameter is called EXCHANGE_LIFETIME in the RFC.
	Maximum Exchanges Per Peer	integer	Maximum number of simultaneous outstanding exchanges towards a remote endpoint. If the limit is exceeded, the request is enqueued. This parameter is called NSTART in the RFC.
	Preferred Block Size	integer	The block size (number of bytes) to use when doing a blockwise transfer. This value serves as the upper limit for block size in blockwise transfers.
	Maximum Message Size	integer	The maximum payload size (in bytes) that can be transferred in a single message, i.e. without requiring a blockwise transfer.
	Maximum Resource Body Size	integer	The maximum size of a resource body (in bytes) that will be accepted from a peer as the payload of a POST/PUT or the response to a GET request in a transparent blockwise transfer.
	Blockwise Status Lifetime	integer	The maximum amount of time (in milliseconds) allowed between transfers of individual blocks in a blockwise transfer before the blockwise transfer state is discarded.
	Congestion Control Algorithm	string	Choose the congestion control algorithm. The value None disables congestion control. Select from one of the following options: None {None} Cocoa {Cocoa} CocoaStrong {CocoaStrong}

* - denotes required

	Parameter	Type	Description
	Receive Buffer Size	integer	The receive buffer size for the socket. The value 0 uses the default.
	Send Buffer Size	integer	The send buffer size for the socket. The value 0 uses the default.
	Receiver Packet Size	integer	The number of bytes of the packet's data buffer that will be used for receiving data.
	Receiver Thread Count	integer	The number of threads which should be used to read UDP
	Sender Thread Count	integer	The number of threads which should be used to send UDP

* - denotes required

	Parameter	Type	Description
	Reuse Address	boolean	Enables address reuse for the socket
	Identity Key Alias	string	Alias for the private key to be used with public key cipher suites
	Keystore Provider	string	Configured Security Provider for the keystore used to retrieve the private key with the Identity Key Alias Click below for a definition: Keystore Configuration
	Truststore Provider	string	Configured Security Provider for the certificate truststore used to validate the peer Click below for a definition: Keystore Configuration
	Prefer Raw Public Keys	boolean	Whether the endpoint should indicate preference for using raw public keys for authentication purposes in the handshake with a peer instead of including the truncated X.509 certificate chain. Default is true. Ignored if the Identity Key Alias is absent.
	Raw Public Key Truststore Provider	string	Configured Security Provider for the raw public key truststore used to validate the peer Click below for a definition: Keystore Configuration
	Fixed PSK Identity	string	The pre-shared key identity to use for all PSK key exchanges. This property overrides the Pre-Shared Key Store since the same identity is used for all peers.
	Fixed Pre-Shared Key	password	The pre-shared key to use for all PSK key exchanges. The format is a hexadecimal string with two hex digits per byte. This property overrides the Pre-Shared Key Store since the same key is used for all peers.
	Pre-Shared Key Store	string	The filepath to an XML document specifying the contents of the PSK store. See the manual for the XML schema. The PSK store declares which pre-shared key to use for a given identity. This property is ignored if the Fixed PSK Identity and the Fixed Pre-Shared Key are configured.
	Supported Cipher Suites	string	Sets the cipher suites supported by the endpoint. The endpoint will use these cipher suites (in exactly the same order) during the DTLS handshake when negotiating a cipher suite with a peer. Example cipher suites are: TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_PSK_WITH_AES_128_CCM_8, TLS_PSK_WITH_AES_128_CBC_SHA256. The default depends on the configuration of the endpoint. Enter as a comma-delimited list or use FILE() function.
	Automatic Session Resumption	integer	Sets the timeout of automatic session resumption in milliseconds. After that period without exchanged messages, the session is forced to resume. The value 0 is the default and it means no automatic session resumption.
	Maximum Fragment Length	integer	Sets the maximum amount of payload data that can be received and processed by this endpoint in a single DTLS record. Used to indicate to peers the Maximum Fragment Length as defined in RFC 6066, Section 4. Also used to determine the amount of memory that will be allocated for receiving UDP datagrams. The value 0 will use a fragment length based on the network interface's maximum transmission unit (MTU). Select from one of the following options: 0 {0} 512 {512} 1024 {1024} 2048 {2048} 4096 {4096}
	Outbound Message Buffer Size	integer	Sets the number of outbound messages that can be buffered in memory before dropping messages.
	Retransmission Timeout	integer	The initial time to wait before a handshake flight of messages gets re-transmitted. After each re-transmission the timeout value is doubled.
	Connection Thread Count	integer	The number of threads which should be used to handle DTLS connections
	Server Name Indication	boolean	Whether the CLIENT_HELLO message sent to a server should include a Server Name Indication extension. The name indicated is based on the hostname in the server address.

* - denotes required

	Parameter	Type	Description
	TCP Thread Count	integer	The number of threads for the NIO event loop. The value 0 uses the default.
	Connection Timeout	integer	The period of time in milliseconds before a connection attempt times out.
	Connection Idle Timeout	integer	The connection is considered idle when neither read nor write was performed for the specified period of time in seconds. The value 0 disables the timeout.

* - denotes required

	Parameter	Type	Description
	SSL Context Provider	string	iWay Security Provider for SSL Context. If using coaps+tcp scheme and SSL Context Provider is left blank, the default SSL Context provider will be used.
	TCP Thread Count	integer	The number of threads for the NIO event loop. The value 0 uses the default.
	Connection Timeout	integer	The period of time in milliseconds before a connection attempt times out.
	Connection Idle Timeout	integer	The connection is considered idle when neither read nor write was performed for the specified period of time in seconds. The value 0 disables the timeout.

* - denotes required