cpp_error_management.md

Error management

Table of Contents

• Overview
  • Example
• Special case
  • Router error callback

Overview

The C++ KINOVA KORTEX™ 3 API uses exceptions to report errors. Wrap service calls in a try/catch block and react to the exception type.

Two exception classes are provided:

Exception	When thrown
KDetailedException	Error reported by the robot (server-side)
KBasicException	Error detected on the client side (transport, timeout, etc.)

Both derive from std::exception, so a single catch (std::exception&) can serve as a fallback.

Example

#include <KDetailedException.h>
#include <BaseClientRpc.h>

namespace k_api = Kinova::Api;

k_api::Base::BaseClient base(router.get());

try
{
    k_api::Base::FullUserProfile profile;
    base.CreateUserProfile(profile);
}
catch (k_api::KDetailedException& ex)
{
    // Server-side error: contains error_code and sub_error_code
    auto& err = ex.getErrorInfo().getError();
    std::cerr << "KDetailedException — code: " << err.error_code()
              << "  sub-code: "                << err.error_sub_code()
              << "  msg: "                     << ex.what() << "\n";
}
catch (k_api::KBasicException& ex)
{
    // Client-side error (timeout, transport failure, etc.)
    std::cerr << "KBasicException: " << ex.what() << "\n";
}
catch (std::exception& ex)
{
    std::cerr << "Unexpected error: " << ex.what() << "\n";
}

A KDetailedException is thrown when the robot reports an error. It carries error code and sub-error code information describing the failure. A KBasicException is thrown when the error occurs on the client side (e.g. timeout or transport failure).

Special case

This section describes a case that does not follow the standard error management rules above.

Router error callback

When a RouterMQTT or RouterClient object is instantiated, an error callback must be provided. This callback is invoked if an unrecoverable transport-level exception occurs outside of a normal service call (e.g. unexpected disconnection).

#include <RouterMQTT.h>

namespace k_api = Kinova::Api;

auto router = std::make_shared<k_api::RouterMQTT>(
    robotIp, mqttPort, "",
    [](k_api::KError err)
    {
        std::cerr << "Router error: " << err.toString() << "\n";
    });

---

Back to root topic: readme.md