WIPE

← Back to Home - To Transport

The WIPE packet is used to remove/clear one or multiple values from the bucket, or to delete the entire bucket.

Request

Wipe request bytemap

Figure A: WIPE request byte-map (header and body)

The WIPE request (see Figure A) includes a header. This header contains one field: the bucket id and is used to indicate which bucket must be wiped.

The WIPE packet accepts one flag:

#6: Delete entire bucket

The body can contain the following fields:

Slot index start (optional): a 2-byte integer (uint-16) that indicates the ‘from’ index of the slot in the bucket that will be cleared. If the slot index end is omitted, this will wipe all slots in the bucket until the end.
Slot index end (optional): a 2-byte integer (uint-16) that indicates the ‘to’ index of the slot in the bucket that will be cleared. All values between the start and end index (including themselves) will be wiped.

If both indexes are omitted, the entire bucket will be wiped.

Response

PUT response bytemap

Figure B: WIPE response byte-map

The WIPE response is empty, and the result is indicated by a status code.

You might encounter the following error codes:

3 (invalid permissions): you are not allowed to wipe this bucket (no write permissions)
4 (authentication failed): the bucket key you are providing might not be valid
21 (bucket does not exist): requested bucket not found
71 (delete not allowed): bucket is not allowed to be deleted

Process and flow

Wipe process

Figure C: WIPE process flow

The WIPE process (see Figure C) goes as follows:

The client sends a WIPE packet containing the bucket id of the bucket to be wiped and optionally a start and/or end index
The server checks if the user has the permissions to write to the bucket. If not, error code 3 is send.
If the 6th flag is set (delete entire bucket) and the bucket has permission 6 (allow delete), the entire bucket is deleted. If not, error 71 is send.
If flag #6 is not set, and the indexes are provided, the slots between the indexes are cleared.
If only the start index is provided, all slots from the start index until the end of the bucket are cleared
If no indexes are provided, all slots are cleared

← Back to Home - To Transport - Prev: PUT packet - Next: REQUEST packet →