Main Interface¶
All of Request’s functionality can be accessed by these 7 methods. They all return an instance of the Response object.
CoAP Protocol constants
| DEFAULT_PORT: | default CoAP port as defined in draft-ietf-core-coap-05, section 7.1: MUST be supported by a server for resource discovery and SHOULD be supported for providing access to other resources. |
|---|---|
| URI_SCHEME_NAME: | |
| CoAP URI scheme name as defined in draft-ietf-core-coap-05, section 11.4. | |
| MAX_RETRANSMIT: | maximal number of retransmissions before the attempt to transmit a message is canceled |
| OBSERVING_REFRESH_INTERVAL: | |
| the number of notifications until a CON notification will be used | |
| DEFAULT_BLOCK_SIZE: | |
| the default block size for block-wise transfers must be power of two between 16 and 1024 bytes. | |
| MESSAGE_CACHE_SIZE: | |
| capacity (in messages) for caches. Used for duplicate detection and retransmissions. | |
| RX_BUFFER_SIZE: | buffer size for incoming datagrams, in bytes |
| DEFAULT_OVERALL_TIMEOUT: | |
| time (in milliseconds) for transaction to complete. Used to avoid infinite waits for replies to non-confirmables and separate responses | |
| RESPONSE_TIMEOUT & RESPONSE_RANDOM_FACTOR: | |
| constants to calculate initial timeout for confirmable messages, used by the exponential backoff mechanism | |
| TODO: | Find a better value for RX_BUFFER_SIZE |
This part of the documentation covers all the interfaces of Pycolo. For parts where Pycolo depends on external libraries, we document the most important right here and provide links to the canonical documentation.
All of Request’s functionality can be accessed by these 7 methods. They all return an instance of the Response object.
These functions are used internally, but may be useful outside of Requests.
Registry of all constant status code
| codes: | describes the CoAP Code Registry |
|---|---|
| mediaCodes: | describes the CoAP Media Type Registry |
| options: | describes the CoAP Option Number Registry |
These items are an internal component to Pycolo, and should never be seen by the end user (developer). This part of the API documentation exists for those who are extending the functionality of Pycolo.