reply

struct mikrotik::api::reply

The sentence sent as a reply from the MikroTik device.

Contains the reply word and the attributes that were sent as a response by the MikroTik device.

It’s difference to a sentence is mostly that it’s received and not sent. While a sentence contains a command which is sent then executed on the device, a reply sentence contains the results of that execution. They may contain that it’s been successfully completed, some content that was generated, or some error.

A valid reply sentence matches the following EBNF grammar:

reply sentence ::= "!", reply content;

reply content ::= reply done
                | reply re
                | reply trap
                | reply fatal
                ;

reply done ::= "done";

reply re ::= "re", { attribute };

reply trap ::= "trap", attribute;

reply fatal ::= "fatal", attribute;

For the attribute grammar see its documentation.

Since

v1.0.0

Public Types

enum type

The reply sentence’s type.

The type of the reply sent from the MikroTik device as response to the sent sentence. They are represented by a leading exclamation mark: eg. done is sent as !done.

Since

v1.0.0

Values:

enumerator done

Denotes the last reply word to a sent sentence. Always comes last and the sentence never contains any other words.

Since

v1.0.0

enumerator trap

Denotes an error during the processing of the sent sentence. Sentences with this word contain a message word which contains the reason for the error.

Since

v1.0.0

enumerator fatal

Denotes the connection getting terminated.

Since

v1.0.0

enumerator re

Denotes one of the reply sentences that are sent with meaningful content. There may be more, or zero re sentences forming a reply to a sent sentence. The end of re sentences is represented by a done sentence.

Since

v1.0.0

Public Members

type reply_type

The type of the reply sentence received.

std::vector<std::string> attributes

Content attributes of the received sentence.