polardbxengine/plugin/polarx_rpc/protocol/polarx_connection.proto

67 lines
1.9 KiB
Protocol Buffer

/*
* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; version 2 of the
* License.
*
* 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 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
*/
syntax = "proto2";
// ifdef PROTOBUF_LITE: option optimize_for = LITE_RUNTIME;
import "polarx_datatypes.proto";
package Polarx.Connection;
option java_package = "com.mysql.cj.polarx.protobuf";
// a Capability
//
// a tuple of a ``name`` and a :protobuf:msg:`Polarx.Datatypes::Any`
message Capability {
required string name = 1;
required Polarx.Datatypes.Any value = 2;
}
// Capabilities
message Capabilities {
repeated Capability capabilities = 1;
}
// get supported connection capabilities and their current state
//
// :returns: :protobuf:msg:`Polarx.Connection::Capabilities` or :protobuf:msg:`Polarx::Error`
//
message CapabilitiesGet {
};
// sets connection capabilities atomically
//
// only provided values are changed, other values are left unchanged.
// If any of the changes fails, all changes are discarded.
//
// :precond: active sessions == 0
// :returns: :protobuf:msg:`Polarx::Ok` or :protobuf:msg:`Polarx::Error`
message CapabilitiesSet {
required Capabilities capabilities = 1;
};
// announce to the server that the client wants to close the connection
//
// it discards any session state of the server
//
// :Returns: :protobuf:msg:`Polarx::Ok`
message Close {
};