aiocoap.numbers.codes module¶
List of known values for the CoAP “Code” field.
The values in this module correspond to the IANA registry “CoRE Parameters”, subregistries “CoAP Method Codes” and “CoAP Response Codes”.
The codes come with methods that can be used to get their rough meaning, see
the Code class for details.
- class aiocoap.numbers.codes.Code(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
ExtensibleIntEnumValue for the CoAP “Code” field.
As the number range for the code values is separated, the rough meaning of a code can be determined using the
is_request(),is_response()andis_successful()methods.- EMPTY = 0¶
- GET = 1¶
- POST = 2¶
- PUT = 3¶
- DELETE = 4¶
- FETCH = 5¶
- PATCH = 6¶
- iPATCH = 7¶
- CREATED = 65¶
- DELETED = 66¶
- VALID = 67¶
- CHANGED = 68¶
- CONTENT = 69¶
- CONTINUE = 95¶
- BAD_REQUEST = 128¶
- UNAUTHORIZED = 129¶
- BAD_OPTION = 130¶
- FORBIDDEN = 131¶
- NOT_FOUND = 132¶
- METHOD_NOT_ALLOWED = 133¶
- NOT_ACCEPTABLE = 134¶
- REQUEST_ENTITY_INCOMPLETE = 136¶
- CONFLICT = 137¶
- PRECONDITION_FAILED = 140¶
- REQUEST_ENTITY_TOO_LARGE = 141¶
- UNSUPPORTED_CONTENT_FORMAT = 143¶
- property UNSUPPORTED_MEDIA_TYPE¶
- UNPROCESSABLE_ENTITY = 150¶
- TOO_MANY_REQUESTS = 157¶
- INTERNAL_SERVER_ERROR = 160¶
- NOT_IMPLEMENTED = 161¶
- BAD_GATEWAY = 162¶
- SERVICE_UNAVAILABLE = 163¶
- GATEWAY_TIMEOUT = 164¶
- PROXYING_NOT_SUPPORTED = 165¶
- HOP_LIMIT_REACHED = 168¶
- CSM = 225¶
- PING = 226¶
- PONG = 227¶
- RELEASE = 228¶
- ABORT = 229¶
- is_request()¶
True if the code is in the request code range
- is_response()¶
True if the code is in the response code range
- is_signalling()¶
- is_successful()¶
True if the code is in the successful subrange of the response code range
- can_have_payload()¶
True if a message with that code can carry a payload. This is not checked for strictly, but used as an indicator.
- property class_¶
The class of a code (distinguishing whether it’s successful, a request or a response error or more).
>>> Code.CONTENT <Successful Response Code 69 "2.05 Content"> >>> Code.CONTENT.class_ 2 >>> Code.BAD_GATEWAY <Response Code 162 "5.02 Bad Gateway"> >>> Code.BAD_GATEWAY.class_ 5
- property dotted¶
The numeric value three-decimal-digits (c.dd) form
- property name_printable¶
The name of the code in human-readable form
