/*
 * Copyright (c) 2017, 2024, Oracle and/or its affiliates.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2.0,
 * as published by the Free Software Foundation.
 *
 * This program is designed to work with certain software (including
 * but not limited to OpenSSL) that is licensed under separate terms,
 * as designated in a particular file or component or in included license
 * documentation. The authors of MySQL hereby grant you an additional
 * permission to link the program and your derivative works with the
 * separately licensed software that they have either included with
 * the program or referenced in the documentation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License, version 2.0, for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef PLUGIN_X_SRC_INTERFACE_VIO_H_
#define PLUGIN_X_SRC_INTERFACE_VIO_H_

#include <cstdint>
#include <string>

#include "my_io.h" // NOLINT(build/include_subdir)
#include "mysql/psi/psi_socket.h"
#include "violite.h" // NOLINT(build/include_subdir)

#include "plugin/x/src/io/connection_type.h"

namespace xpl {
namespace iface {

class Vio {
 public:
 enum class Direction { k_read = 0, k_write = 1 };

 virtual ssize_t read(uchar *buffer, ssize_t bytes_to_send) = 0;
 virtual ssize_t write(const uchar *buffer, ssize_t bytes_to_send) = 0;

 virtual void set_timeout_in_ms(const Direction direction,
 const uint64_t timeout) = 0;

 virtual void set_state(const PSI_socket_state state) = 0;
 virtual void set_thread_owner() = 0;

 virtual my_socket get_fd() = 0;
 virtual Connection_type get_type() const = 0;
 virtual sockaddr_storage *peer_addr(std::string *address, uint16_t *port) = 0;

 virtual int32_t shutdown() = 0;

 virtual ::Vio *get_vio() = 0;
 virtual MYSQL_SOCKET &get_mysql_socket() = 0;

 virtual ~Vio() = default;
};

} // namespace iface
} // namespace xpl

#endif // PLUGIN_X_SRC_INTERFACE_VIO_H_