phosphor-net-ipmid/sol/sol_manager.hpp

16 namespace sol  namespace
35  *  Manager class acts a manager for the SOL payload instances and provides
46     /** @brief SOL Payload Instance is the key for the map, the value is the
47      *         SOL context.
86      *  This parameter is used to indicate when any of the SOL parameters
94     /** @brief SOL enable
96      *  This controls whether the SOL payload can be activated. By default
97      *  the SOL is enabled.
101     /** @brief SOL payload encryption.
105      *  all SOL payload data. Encryption controlled by remote console:
106      *  Whether SOL packets are encrypted or not is selectable by the remote
112     /** @brief SOL payload authentication.
116      *  authentication for all SOL payload data. Authentication controlled
124     /** @brief SOL privilege level.
127      *  able to activate SOL using the Activate Payload command.
134      *  transmitting a partial SOL character data packet. (Where a partial
137      *  threshold. This parameter can be modified by the set SOL
138      *  configuration parameters command. The SOL configuration parameter,
147      *  The BMC will automatically send an SOL character data packet
155      *  SOL configuration parameters command.
164      *  set SOL configuration parameters command.
171      *  time between retries when sending SOL packets to the remote console.
172      *  This parameter can be modified by the set SOL configuration
173      *  parameters command. The SOL configuration parameter Retry Interval
182      *  communication parameters (e.g. IP address, MAC address) for the SOL
184      *  that the Activate Payload command for SOL was accepted over. The
195     /** @brief Start a SOL payload instance.
201      *  @param[in] payloadInstance - SOL payload instance.
207     /** @brief Stop SOL payload instance.
213      *  @param[in] payloadInstance - SOL payload instance
217     /* @brief Stop all the active SOL payload instances */
220     /** @brief Get SOL Context by Payload Instance.
222      *  @param[in] payloadInstance - SOL payload instance.
224      *  @return reference to the SOL payload context.
236             "Invalid SOL payload instance " + std::to_string(payloadInstance);  in getContext()
240     /** @brief Get SOL Context by Session ID.
244      *  @return reference to the SOL payload context.
256         std::string msg = "Invalid SOL SessionID " + std::to_string(sessionID);  in getContext()
260     /** @brief Check if SOL payload is active.
262      *  @param[in] payloadInstance - SOL payload instance.
295 /** @brief Callback method to close SOL sessions for SOL service change  */
298 /** @brief Callback register method to SOL conf parameters change */
301 } // namespace sol