vhal_connector.h

Go to the documentation of this file.

/*
 * This file is part of Anbox Platform SDK
 *
 * Copyright 2024 Canonical Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef ANBOX_SDK_VHAL_CONNECTOR_H_
#define ANBOX_SDK_VHAL_CONNECTOR_H_
 
#include <stdbool.h>
#include <stdint.h>
 
typedef AnboxVhalAnswerStatus (*AnboxVhalGetAllPropConfigsCallback)(
  AnboxVhalAnswerGetConfigs *result, void *user_data);
 
typedef AnboxVhalAnswerStatus (*AnboxVhalGetPropConfigsCallback)(
  int32_t *props, size_t props_size, AnboxVhalAnswerGetConfigs *result,
  void *user_data);
 
typedef bool (*AnboxVhalIsAvailableCallback)(void *user_data);
 
typedef AnboxVhalAnswerStatus (*AnboxVhalGetCallback)(
  AnboxVhalCommandGet *request, AnboxVhalPropertyValue *result,
  void *user_data);
 
typedef AnboxVhalAnswerStatus (*AnboxVhalSetCallback)(
  AnboxVhalCommandSet *request, void *user_data);
 
struct AnboxVhalConnectorCallbacks {
  AnboxVhalGetAllPropConfigsCallback get_all_prop_configs_callback = nullptr;
  AnboxVhalGetPropConfigsCallback get_prop_configs_callback = nullptr;
  AnboxVhalIsAvailableCallback is_available_callback = nullptr;
  AnboxVhalGetCallback get_callback = nullptr;
  AnboxVhalSetCallback set_callback = nullptr;
};
 
namespace anbox {
class VhalConnector {
 public:
  VhalConnector() = default;
  virtual ~VhalConnector() = default;
  VhalConnector(const VhalConnector &) = delete;
  VhalConnector &operator=(const VhalConnector &) = delete;
 
  bool is_available() {
    if (!callbacks_.is_available_callback)
      return false;
    return callbacks_.is_available_callback(user_data_);
  }
 
  AnboxVhalAnswerStatus get_all_prop_configs(
    AnboxVhalAnswerGetConfigs *result) {
    if (!callbacks_.get_all_prop_configs_callback)
      return ANBOX_VHAL_ANSWER_STATUS_INVALID;
    return callbacks_.get_all_prop_configs_callback(result, user_data_);
  }
 
  AnboxVhalAnswerStatus get_prop_configs(int32_t *props, size_t props_size,
                                         AnboxVhalAnswerGetConfigs *result) {
    if (!callbacks_.get_prop_configs_callback)
      return ANBOX_VHAL_ANSWER_STATUS_INVALID;
    return callbacks_.get_prop_configs_callback(props, props_size, result,
                                                user_data_);
  }
 
  AnboxVhalAnswerStatus get(AnboxVhalCommandGet *request,
                            AnboxVhalPropertyValue *result) {
    if (!callbacks_.get_callback)
      return ANBOX_VHAL_ANSWER_STATUS_INVALID;
    return callbacks_.get_callback(request, result, user_data_);
  }
 
  AnboxVhalAnswerStatus set(AnboxVhalCommandSet *request) {
    if (!callbacks_.set_callback)
      return ANBOX_VHAL_ANSWER_STATUS_INVALID;
    return callbacks_.set_callback(request, user_data_);
  }
 
  void set_callbacks(const AnboxVhalConnectorCallbacks &callbacks,
                     void *user_data) {
    callbacks_ = callbacks;
    user_data_ = user_data;
  }
 
 private:
  AnboxVhalConnectorCallbacks callbacks_;
  void *user_data_{nullptr};
};
} // namespace anbox
 
#endif