acme.plugins.bindings.CoAPServer.ACMECoAPHandler

class documentation

class ACMECoAPHandler:

Constructor: ACMECoAPHandler(coapServer)

ACME CoAP request handler.

Method	`__init__`	Initialization of the ACME CoAP Resource.
Method	`handleDELETE`	Handle a DELETE request.
Method	`handleFETCH`	Handle a FETCH request.
Method	`handleGET`	Handle a GET request.
Method	`handlePOST`	Handle a POST request.
Method	`handlePUT`	Handle a PUT request.
Class Variable	`__slots__`	Slots of the ACME CoAP Handler.
Class Variable	`requestManager`	Injected RequestManager instance.
Instance Variable	`coapServer`	The CoAP server object.
Method	`_dissectRequest`	Dissect a CoAP request.
Method	`_handleRequest`	Handle a CoAP request.
Method	`_prepareResponse`	Prepare a CoAP response.

def __init__(self, coapServer: ACMECoAPServer = None): ¶

Initialization of the ACME CoAP Resource.

Parameters
coapServer:`ACMECoAPServer`	The CoAP server object.

def handleDELETE(self, request: CoaptthonRequest, response: CoapthonResponse, options: MultiDict): ¶

Handle a DELETE request.

Parameters
request:`CoaptthonRequest`	The CoAP request.
response:`CoapthonResponse`	The CoAP response.
options:`MultiDict`	The options of the request.

def handleFETCH(self, request: CoaptthonRequest, response: CoapthonResponse, options: MultiDict): ¶

Handle a FETCH request.

Parameters
request:`CoaptthonRequest`	The CoAP request.
response:`CoapthonResponse`	The CoAP response.
options:`MultiDict`	The options of the request.

def handleGET(self, request: CoaptthonRequest, response: CoapthonResponse, options: MultiDict): ¶

Handle a GET request.

Parameters
request:`CoaptthonRequest`	The CoAP request.
response:`CoapthonResponse`	The CoAP response.
options:`MultiDict`	The options of the request.

def handlePOST(self, request: CoaptthonRequest, response: CoapthonResponse, options: MultiDict): ¶

Handle a POST request.

Parameters
request:`CoaptthonRequest`	The CoAP request.
response:`CoapthonResponse`	The CoAP response.
options:`MultiDict`	The options of the request.

def handlePUT(self, request: CoaptthonRequest, response: CoapthonResponse, options: MultiDict): ¶

Handle a PUT request.

Parameters
request:`CoaptthonRequest`	The CoAP request.
response:`CoapthonResponse`	The CoAP response.
options:`MultiDict`	The options of the request.

__slots__: tuple[str, ...] = ¶

Slots of the ACME CoAP Handler.

requestManager: RequestManager = ¶

Injected RequestManager instance.

coapServer = ¶

The CoAP server object.

def _dissectRequest(self, request: CoaptthonRequest, operation: Operation, options: MultiDict | None = None) -> Result: ¶

Dissect a CoAP request.

Parameters
request:`CoaptthonRequest`	The CoAP request.
operation:`Operation`	The operation of the request.
options:`MultiDict \| None`	The options of the request.

Returns
`Result`	The result of the dissection. Contains a CSERequest object.

Raises
`ResponseException`	If the request is invalid.

def _handleRequest(self, request: CoaptthonRequest, response: CoapthonResponse, operation: Operation, options: MultiDict | None = None) -> CoapthonResponse: ¶

Handle a CoAP request.

Parameters
request:`CoaptthonRequest`	The CoAP request.
response:`CoapthonResponse`	The CoAP response.
operation:`Operation`	The operation of the request.
options:`MultiDict \| None`	The options of the request.

Returns
`CoapthonResponse`	The CoAP response.

def _prepareResponse(self, result: Result, response: CoapthonResponse, originalRequest: CSERequest | None = None) -> CoapthonResponse: ¶

Prepare a CoAP response.

Parameters
result:`Result`	The result of the request.
response:`CoapthonResponse`	The CoAP response.
originalRequest:`CSERequest \| None`	The original request.

Returns
`CoapthonResponse`	The prepared CoAP response.