Commit dad29c96 authored by Andrew Mitchell's avatar Andrew Mitchell
Browse files

Renamed FLUSH to FLUSH_ALL_DATA to avoid c++ enum collision with Synchronization::FLUSH

parent 770015d9
Loading
Loading
Loading
Loading
+9 −9
Original line number Diff line number Diff line
@@ -522,9 +522,9 @@ There are many cases where a delete could fail with a properly functioning drive
* `code = NOT_AUTHORIZED` The identity doesn't have permission to delete this value, in this case `status.statusMessage` will be "permission denied."


### Flus
The `FLUSH` operation flushes any outstanding PUTs or DELETEs on the device. For example, if the client `PUT` many keys with `synchronization=WRITEBACK` the data
would not be guaranteed to be persisted, so power cycling could result in lost data. When a `FLUSH` command returns, all previous operations with `synchronization=WRITEBACK` on
### Flush
The `FLUSH_ALL_DATA` operation flushes any outstanding PUTs or DELETEs on the device. For example, if the client `PUT` many keys with `synchronization=WRITEBACK` the data
would not be guaranteed to be persisted, so power cycling could result in lost data. When a `FLUSH_ALL_DATA` command returns, all previous operations with `synchronization=WRITEBACK` on
this connection are guaranteed to be persisted. Data on separate connections is not guaranteed to be persisted, but may as an indirect consequence of this operation.

**Request Message**
@@ -539,8 +539,8 @@ command {
    identity: ...
    connectionID: ...
    sequence: ...
    // messageType should be FLUSH
    messageType: FLUSH
    // messageType should be FLUSH_ALL_DATA
    messageType: FLUSH_ALL_DATA
  }
  body {
  }
@@ -559,13 +559,13 @@ command {
  header {
    ackSequence: ...

    // messageType should be FLUSH_RESPONSE
    messageType: FLUSH_RESPONSE
    // messageType should be FLUSH_ALL_DATA_RESPONSE
    messageType: FLUSH_ALL_DATA_RESPONSE
  }
  body {
  }
  status {
  // A successful FLUSH will return SUCCESS
  // A successful FLUSH_ALL_DATA will return SUCCESS
    code: SUCCESS
  }
}
@@ -574,7 +574,7 @@ hmac: "..."
```

**Permissions**
Having unrestricted `WRITE` or `DELETE` permissions is sufficient to execute a `FLUSH` command.
Having unrestricted `WRITE` or `DELETE` permissions is sufficient to execute a `FLUSH_ALL_DATA` command.


## Read Operations
+2 −2
Original line number Diff line number Diff line
@@ -542,8 +542,8 @@ message Message {
    NOOP = 30;
    NOOP_RESPONSE = 29;

    FLUSH = 32;
    FLUSH_RESPONSE = 31;
    FLUSH_ALL_DATA = 32;
    FLUSH_ALL_DATA_RESPONSE = 31;
  }

}