|
|
|
/*
|
|
|
|
*
|
|
|
|
* Copyright 2015, Google Inc.
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions are
|
|
|
|
* met:
|
|
|
|
*
|
|
|
|
* * Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* * Redistributions in binary form must reproduce the above
|
|
|
|
* copyright notice, this list of conditions and the following disclaimer
|
|
|
|
* in the documentation and/or other materials provided with the
|
|
|
|
* distribution.
|
|
|
|
* * Neither the name of Google Inc. nor the names of its
|
|
|
|
* contributors may be used to endorse or promote products derived from
|
|
|
|
* this software without specific prior written permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __GRPCPP_CHANNEL_ARGUMENTS_H_
|
|
|
|
#define __GRPCPP_CHANNEL_ARGUMENTS_H_
|
|
|
|
|
|
|
|
#include <vector>
|
|
|
|
#include <list>
|
|
|
|
|
|
|
|
#include <grpc++/config.h>
|
|
|
|
#include <grpc/grpc.h>
|
|
|
|
|
|
|
|
namespace grpc {
|
|
|
|
namespace testing {
|
|
|
|
class ChannelArgumentsTest;
|
|
|
|
} // namespace testing
|
|
|
|
|
|
|
|
// Options for channel creation. The user can use generic setters to pass
|
|
|
|
// key value pairs down to c channel creation code. For grpc related options,
|
|
|
|
// concrete setters are provided.
|
|
|
|
class ChannelArguments {
|
|
|
|
public:
|
|
|
|
ChannelArguments() {}
|
|
|
|
~ChannelArguments() {}
|
|
|
|
|
|
|
|
// grpc specific channel argument setters
|
|
|
|
// Set target name override for SSL host name checking.
|
|
|
|
void SetSslTargetNameOverride(const grpc::string& name);
|
|
|
|
// TODO(yangg) add flow control options
|
|
|
|
|
|
|
|
// Generic channel argument setters. Only for advanced use cases.
|
|
|
|
void SetInt(const grpc::string& key, int value);
|
|
|
|
void SetString(const grpc::string& key, const grpc::string& value);
|
|
|
|
|
|
|
|
private:
|
|
|
|
friend class Channel;
|
|
|
|
friend class testing::ChannelArgumentsTest;
|
|
|
|
|
|
|
|
// TODO(yangg) implement copy and assign
|
|
|
|
ChannelArguments(const ChannelArguments&);
|
|
|
|
ChannelArguments& operator=(const ChannelArguments&);
|
|
|
|
|
|
|
|
// Returns empty string when it is not set.
|
|
|
|
grpc::string GetSslTargetNameOverride() const;
|
|
|
|
|
|
|
|
// Populates given channel_args with args_, does not take ownership.
|
|
|
|
void SetChannelArgs(grpc_channel_args* channel_args) const;
|
|
|
|
|
|
|
|
std::vector<grpc_arg> args_;
|
|
|
|
std::list<grpc::string> strings_;
|
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace grpc
|
|
|
|
|
|
|
|
#endif // __GRPCPP_CHANNEL_ARGUMENTS_H_
|