Member values
| Member name | Data type | Description |
|---|---|---|
| username | string | User name |
| session_inactivity_timeout | uint32 | Inactivity period (in milliseconds) allowed before the session times out and closes on its own |
| password | string | Password for the user |
| connection_inactivity_timeout | uint32 | Inactivity period (in milliseconds) allowed before the robot stops any movements initiated from this session |
Member functions
| Function name | Return type | Input type | Description |
|---|---|---|---|
| username() | const string& | void | Returns the current value of username. If username is not set, returns the empty string/empty bytes. |
| set_username() | void | const string& | Sets the value of username. After calling this, username() will return a copy of value. |
| set_username() | void | string&& | (C++11 and beyond): Sets the value of username, moving from the passed string. After calling this, username() will return a copy of value. |
| set_username() | void | const char* | Sets the value of username using a C-style null-terminated string. After calling this, username() will return a copy of value. |
| mutable_username() | string * | void | Returns a pointer to the mutable string object that stores username's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, username() will return whatever value is written into the given string. |
| clear_username() | void | void | Clears the value of username. After calling this, username() will return the empty string/empty bytes. |
| set_allocated_username() | void | string* | Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_username(). |
| release_username() | string * | void | Releases the ownership of username and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and username() will return the empty string/empty bytes. |
| session_inactivity_timeout() | uint32 | void | Returns the current value of session_inactivity_timeout. If the session_inactivity_timeout is not set, returns 0. |
| set_session_inactivity_timeout() | void | uint32 | Sets the value of session_inactivity_timeout. After calling this, session_inactivity_timeout() will return value. |
| clear_session_inactivity_timeout() | void | void | Clears the value of session_inactivity_timeout. After calling this, session_inactivity_timeout() will return 0. |
| password() | const string& | void | Returns the current value of password. If password is not set, returns the empty string/empty bytes. |
| set_password() | void | const string& | Sets the value of password. After calling this, password() will return a copy of value. |
| set_password() | void | string&& | (C++11 and beyond): Sets the value of password, moving from the passed string. After calling this, password() will return a copy of value. |
| set_password() | void | const char* | Sets the value of password using a C-style null-terminated string. After calling this, password() will return a copy of value. |
| mutable_password() | string * | void | Returns a pointer to the mutable string object that stores password's value. If the field was not set prior to the call, then the returned string will be empty. After calling this, password() will return whatever value is written into the given string. |
| clear_password() | void | void | Clears the value of password. After calling this, password() will return the empty string/empty bytes. |
| set_allocated_password() | void | string* | Sets the string object to the field and frees the previous field value if it exists. If the string pointer is not NULL, the message takes ownership of the allocated string object. The message is free to delete the allocated string object at any time, so references to the object may be invalidated. Otherwise, if the value is NULL, the behavior is the same as calling clear_password(). |
| release_password() | string * | void | Releases the ownership of password and returns the pointer of the string object. After calling this, caller takes the ownership of the allocated string object and password() will return the empty string/empty bytes. |
| connection_inactivity_timeout() | uint32 | void | Returns the current value of connection_inactivity_timeout. If the connection_inactivity_timeout is not set, returns 0. |
| set_connection_inactivity_timeout() | void | uint32 | Sets the value of connection_inactivity_timeout. After calling this, connection_inactivity_timeout() will return value. |
| clear_connection_inactivity_timeout() | void | void | Clears the value of connection_inactivity_timeout. After calling this, connection_inactivity_timeout() will return 0. |
Parent topic: Session (C++)