grpc Namespace Reference

This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInputStream interface. More...

Namespaces
	experimental
	ClientRpcInfo represents the state of a particular RPC as it appears to an interceptor.
	internal
	Models a gRPC server.
	protobuf
	testing

Data Structures
class	AsyncGenericService
class	AuthContext
	Class encapsulating the Authentication Information. More...
class	AuthMetadataProcessor
	Interface allowing custom server-side authorization based on credentials encoded in metadata. More...
class	AuthPropertyIterator
class	ByteBuffer
	A sequence of bytes. More...
class	CallCredentials
	A call credentials object encapsulates the state needed by a client to authenticate with a server for a given call on a channel. More...
class	Channel
	Channels represent a connection to an endpoint. Created by CreateChannel. More...
class	ChannelArguments
	Options for channel creation. More...
class	ChannelCredentials
	A channel credentials object encapsulates all the state needed by a client to authenticate with a server for a given channel. More...
class	ChannelInterface
	Codegen interface for grpc::Channel. More...
class	ClientContext
	A ClientContext allows the person implementing a service client to: More...
class	CompletionQueue
	A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue.h). More...
class	CoreCodegen
	Implementation of the core codegen interface. More...
class	CoreCodegenInterface
	Interface between the codegen library and the minimal subset of core features required by the generated code. More...
class	GenericServerContext
class	GrpcLibraryCodegen
	Classes that require gRPC to be initialized should inherit from this class. More...
class	GrpcLibraryInterface
class	HealthCheckServiceInterface
	The gRPC server uses this interface to expose the health checking service without depending on protobuf. More...
class	HealthCheckServiceServerBuilderOption
class	MetadataCredentialsPlugin
	User defined metadata credentials. More...
class	PropagationOptions
	Options for ClientContext::FromServerContext specifying which traits from the ServerContext to propagate (copy) from it into a new ClientContext. More...
class	ProtoBufferReader
	This is a specialization of the protobuf class ZeroCopyInputStream The principle is to get one chunk of data at a time from the proto layer, with options to backup (re-see some bytes) or skip (forward past some bytes) More...
class	ProtoBufferWriter
	This is a specialization of the protobuf class ZeroCopyOutputStream. More...
class	ResourceQuota
	ResourceQuota represents a bound on memory and thread usage by the gRPC library. More...
class	SerializationTraits
	Defines how to serialize and deserialize some type. More...
class	SerializationTraits< ByteBuffer, void >
class	ServerBuilder
	A builder class for the creation and startup of grpc::Server instances. More...
class	ServerBuilderPlugin
	This interface is meant for internal usage only. More...
class	ServerCompletionQueue
	A specific type of completion queue used by the processing of notifications by servers. More...
class	ServerCredentials
	Wrapper around grpc_server_credentials, a way to authenticate a server. More...
class	ServerInterface
class	Service
	Desriptor of an RPC service and its various RPC methods. More...
class	Slice
	A wrapper around grpc_slice. More...
struct	SslCredentialsOptions
	Options used to build SslCredentials. More...
struct	SslServerCredentialsOptions
	Options to create ServerCredentials with SSL. More...
class	Status
	Did it work? If it didn't, why? More...
class	string_ref
	This class is a non owning reference to a string. More...
class	StubOptions
	Useful interface for generated stubs. More...
class	TemplatedGenericStub
	Generic stubs provide a type-unaware interface to call gRPC methods by name. More...
class	TimePoint
	If you are trying to use CompletionQueue::AsyncNext with a time class that isn't either gpr_timespec or std::chrono::system_clock::time_point, you will most likely be looking at this comment as your compiler will have fired an error below. More...
class	TimePoint< gpr_timespec >
class	TimePoint< std::chrono::system_clock::time_point >
class	WriteOptions
	Per-message write options. More...

Typedefs
typedef ::grpc_impl::Alarm	Alarm
typedef ::grpc_impl::ClientAsyncReaderWriter< ByteBuffer, ByteBuffer >	GenericClientAsyncReaderWriter
typedef ::grpc_impl::ClientAsyncResponseReader< ByteBuffer >	GenericClientAsyncResponseReader
typedef TemplatedGenericStub< grpc::ByteBuffer, grpc::ByteBuffer >	GenericStub
typedef ::grpc_impl::ServerAsyncReaderWriter< ByteBuffer, ByteBuffer >	GenericServerAsyncReaderWriter
typedef ::grpc_impl::ServerAsyncResponseWriter< ByteBuffer >	GenericServerAsyncResponseWriter
typedef ::grpc_impl::ServerAsyncReader< ByteBuffer, ByteBuffer >	GenericServerAsyncReader
typedef ::grpc_impl::ServerAsyncWriter< ByteBuffer >	GenericServerAsyncWriter
template<class R >
using	ClientAsyncReaderInterface = ::grpc_impl::ClientAsyncReaderInterface< R >
template<class R >
using	ClientAsyncReader = ::grpc_impl::ClientAsyncReader< R >
template<class W >
using	ClientAsyncWriterInterface = ::grpc_impl::ClientAsyncWriterInterface< W >
template<class W >
using	ClientAsyncWriter = ::grpc_impl::ClientAsyncWriter< W >
template<class W , class R >
using	ClientAsyncReaderWriterInterface = ::grpc_impl::ClientAsyncReaderWriterInterface< W, R >
template<class W , class R >
using	ClientAsyncReaderWriter = ::grpc_impl::ClientAsyncReaderWriter< W, R >
template<class W , class R >
using	ServerAsyncReaderInterface = ::grpc_impl::ServerAsyncReaderInterface< W, R >
template<class W , class R >
using	ServerAsyncReader = ::grpc_impl::ServerAsyncReader< W, R >
template<class W >
using	ServerAsyncWriterInterface = ::grpc_impl::ServerAsyncWriterInterface< W >
template<class W >
using	ServerAsyncWriter = ::grpc_impl::ServerAsyncWriter< W >
template<class W , class R >
using	ServerAsyncReaderWriterInterface = ::grpc_impl::ServerAsyncReaderWriterInterface< W, R >
template<class W , class R >
using	ServerAsyncReaderWriter = ::grpc_impl::ServerAsyncReaderWriter< W, R >
template<class R >
using	ClientAsyncResponseReaderInterface = grpc_impl::ClientAsyncResponseReaderInterface< R >
template<class R >
using	ClientAsyncResponseReader = grpc_impl::ClientAsyncResponseReader< R >
template<class W >
using	ServerAsyncResponseWriter = ::grpc_impl::ServerAsyncResponseWriter< W >
typedef std::pair< string_ref, string_ref >	AuthProperty
typedef ::grpc_impl::ServerContext	ServerContext
template<class R >
using	ClientReaderInterface = ::grpc_impl::ClientReaderInterface< R >
template<class R >
using	ClientReader = ::grpc_impl::ClientReader< R >
template<class W >
using	ClientWriterInterface = ::grpc_impl::ClientWriterInterface< W >
template<class W >
using	ClientWriter = ::grpc_impl::ClientWriter< W >
template<class W , class R >
using	ClientReaderWriterInterface = ::grpc_impl::ClientReaderWriterInterface< W, R >
template<class W , class R >
using	ClientReaderWriter = ::grpc_impl::ClientReaderWriter< W, R >
template<class R >
using	ServerReaderInterface = ::grpc_impl::ServerReaderInterface< R >
template<class R >
using	ServerReader = ::grpc_impl::ServerReader< R >
template<class W >
using	ServerWriterInterface = ::grpc_impl::ServerWriterInterface< W >
template<class W >
using	ServerWriter = ::grpc_impl::ServerWriter< W >
template<class W , class R >
using	ServerReaderWriterInterface = ::grpc_impl::ServerReaderWriterInterface< W, R >
template<class W , class R >
using	ServerReaderWriter = ::grpc_impl::ServerReaderWriter< W, R >
template<class RequestType , class ResponseType >
using	ServerUnaryStreamer = ::grpc_impl::ServerUnaryStreamer< RequestType, ResponseType >
template<class RequestType , class ResponseType >
using	ServerSplitStreamer = ::grpc_impl::ServerSplitStreamer< RequestType, ResponseType >
typedef ::grpc_impl::ServerBuilderOption	ServerBuilderOption
typedef ::grpc_impl::ServerInitializer	ServerInitializer
typedef ::grpc_impl::Server	Server

Enumerations
enum	StatusCode {   OK = 0, CANCELLED = 1, UNKNOWN = 2, INVALID_ARGUMENT = 3,   DEADLINE_EXCEEDED = 4, NOT_FOUND = 5, ALREADY_EXISTS = 6, PERMISSION_DENIED = 7,   UNAUTHENTICATED = 16, RESOURCE_EXHAUSTED = 8, FAILED_PRECONDITION = 9, ABORTED = 10,   OUT_OF_RANGE = 11, UNIMPLEMENTED = 12, INTERNAL = 13, UNAVAILABLE = 14,   DATA_LOSS = 15, DO_NOT_USE = -1 }

Functions
std::shared_ptr< Channel >	CreateChannelInternal (const std::string &host, grpc_channel *c_channel, std::vector< std::unique_ptr< experimental::ClientInterceptorFactoryInterface >> interceptor_creators)
std::shared_ptr< Channel >	CreateChannel (const grpc::string &target, const std::shared_ptr< ChannelCredentials > &creds)
	Create a new Channel pointing to target. More...
std::shared_ptr< Channel >	CreateCustomChannel (const grpc::string &target, const std::shared_ptr< ChannelCredentials > &creds, const ChannelArguments &args)
	Create a new custom Channel pointing to target. More...
std::string	Version ()
	Return gRPC library version. More...
void	EnableDefaultHealthCheckService (bool enable)
	Enable/disable the default health checking service. More...
bool	DefaultHealthCheckServiceEnabled ()
	Returns whether the default health checking service is enabled. More...
std::unique_ptr< ServerBuilderOption >	MakeChannelArgumentOption (const std::string &name, const std::string &value)
std::unique_ptr< ServerBuilderOption >	MakeChannelArgumentOption (const std::string &name, int value)
std::shared_ptr< const AuthContext >	CreateAuthContext (grpc_call *call)
template<class ProtoBufferWriter , class T >
Status	GenericSerialize (const grpc::protobuf::MessageLite &msg, ByteBuffer *bb, bool *own_buffer)
template<class ProtoBufferReader , class T >
Status	GenericDeserialize (ByteBuffer *buffer, grpc::protobuf::MessageLite *msg)
grpc::string_ref	StringRefFromSlice (const grpc_slice *slice)
std::string	StringFromCopiedSlice (grpc_slice slice)
grpc_slice	SliceReferencingString (const std::string &str)
grpc_slice	SliceFromCopiedString (const std::string &str)
bool	operator== (string_ref x, string_ref y)
	Comparison operators. More...
bool	operator!= (string_ref x, string_ref y)
bool	operator< (string_ref x, string_ref y)
bool	operator<= (string_ref x, string_ref y)
bool	operator> (string_ref x, string_ref y)
bool	operator>= (string_ref x, string_ref y)
std::ostream &	operator<< (std::ostream &out, const string_ref &string)
void	Timepoint2Timespec (const std::chrono::system_clock::time_point &from, gpr_timespec *to)
void	TimepointHR2Timespec (const std::chrono::high_resolution_clock::time_point &from, gpr_timespec *to)
std::chrono::system_clock::time_point	Timespec2Timepoint (gpr_timespec t)
std::shared_ptr< Channel >	CreateCustomChannel (const grpc::string &target, const std::shared_ptr< grpc::ChannelCredentials > &creds, const grpc::ChannelArguments &args)
std::shared_ptr< ChannelCredentials >	GoogleDefaultCredentials ()
	Builds credentials with reasonable defaults. More...
std::shared_ptr< ChannelCredentials >	SslCredentials (const SslCredentialsOptions &options)
	Builds SSL Credentials given SSL specific options. More...
std::shared_ptr< CallCredentials >	GoogleComputeEngineCredentials ()
	Builds credentials for use when running in GCE. More...
std::shared_ptr< CallCredentials >	ServiceAccountJWTAccessCredentials (const grpc::string &json_key, long token_lifetime_seconds=kMaxAuthTokenLifetimeSecs)
	Builds Service Account JWT Access credentials. More...
std::shared_ptr< CallCredentials >	GoogleRefreshTokenCredentials (const grpc::string &json_refresh_token)
	Builds refresh token credentials. More...
std::shared_ptr< CallCredentials >	AccessTokenCredentials (const grpc::string &access_token)
	Builds access token credentials. More...
std::shared_ptr< CallCredentials >	GoogleIAMCredentials (const grpc::string &authorization_token, const grpc::string &authority_selector)
	Builds IAM credentials. More...
std::shared_ptr< ChannelCredentials >	CompositeChannelCredentials (const std::shared_ptr< ChannelCredentials > &channel_creds, const std::shared_ptr< CallCredentials > &call_creds)
	Combines a channel credentials and a call credentials into a composite channel credentials. More...
std::shared_ptr< CallCredentials >	CompositeCallCredentials (const std::shared_ptr< CallCredentials > &creds1, const std::shared_ptr< CallCredentials > &creds2)
	Combines two call credentials objects into a composite call credentials. More...
std::shared_ptr< ChannelCredentials >	InsecureChannelCredentials ()
	Credentials for an unencrypted, unauthenticated channel. More...
std::shared_ptr< CallCredentials >	MetadataCredentialsFromPlugin (std::unique_ptr< MetadataCredentialsPlugin > plugin)
std::shared_ptr< ServerCredentials >	SslServerCredentials (const grpc::SslServerCredentialsOptions &options)
	Builds SSL ServerCredentials given SSL specific options. More...
std::shared_ptr< ServerCredentials >	InsecureServerCredentials ()

Variables
const char	kHealthCheckServiceInterfaceArg []
CoreCodegenInterface *	g_core_codegen_interface
GrpcLibraryInterface *	g_glip
	Initialized by grpc::GrpcLibraryInitializer from <grpcpp/impl/grpc_library.h> More...
const int	kProtoBufferWriterMaxBufferLength = 1024 * 1024
constexpr long	kMaxAuthTokenLifetimeSecs = 3600

Detailed Description

This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInputStream interface.

This header provides serialization and deserialization between gRPC messages serialized using protobuf and the C++ objects they represent.

This header provides an object that writes bytes directly into a grpc::ByteBuffer, via the ZeroCopyOutputStream interface.

Typedef Documentation

Alarm

typedef ::grpc_impl::Alarm grpc::Alarm

AuthProperty

typedef std::pair<string_ref, string_ref> grpc::AuthProperty

ClientAsyncReader

template<class R >

using grpc::ClientAsyncReader = typedef ::grpc_impl::ClientAsyncReader<R>

ClientAsyncReaderInterface

template<class R >

using grpc::ClientAsyncReaderInterface = typedef ::grpc_impl::ClientAsyncReaderInterface<R>

ClientAsyncReaderWriter

template<class W , class R >

using grpc::ClientAsyncReaderWriter = typedef ::grpc_impl::ClientAsyncReaderWriter<W, R>

ClientAsyncReaderWriterInterface

template<class W , class R >

using grpc::ClientAsyncReaderWriterInterface = typedef ::grpc_impl::ClientAsyncReaderWriterInterface<W, R>

ClientAsyncResponseReader

template<class R >

using grpc::ClientAsyncResponseReader = typedef grpc_impl::ClientAsyncResponseReader<R>

ClientAsyncResponseReaderInterface

template<class R >

using grpc::ClientAsyncResponseReaderInterface = typedef grpc_impl::ClientAsyncResponseReaderInterface<R>

ClientAsyncWriter

template<class W >

using grpc::ClientAsyncWriter = typedef ::grpc_impl::ClientAsyncWriter<W>

ClientAsyncWriterInterface

template<class W >

using grpc::ClientAsyncWriterInterface = typedef ::grpc_impl::ClientAsyncWriterInterface<W>

ClientReader

template<class R >

using grpc::ClientReader = typedef ::grpc_impl::ClientReader<R>

ClientReaderInterface

template<class R >

using grpc::ClientReaderInterface = typedef ::grpc_impl::ClientReaderInterface<R>

ClientReaderWriter

template<class W , class R >

using grpc::ClientReaderWriter = typedef ::grpc_impl::ClientReaderWriter<W, R>

ClientReaderWriterInterface

template<class W , class R >

using grpc::ClientReaderWriterInterface = typedef ::grpc_impl::ClientReaderWriterInterface<W, R>

ClientWriter

template<class W >

using grpc::ClientWriter = typedef ::grpc_impl::ClientWriter<W>

ClientWriterInterface

template<class W >

using grpc::ClientWriterInterface = typedef ::grpc_impl::ClientWriterInterface<W>

GenericClientAsyncReaderWriter

typedef ::grpc_impl::ClientAsyncReaderWriter<ByteBuffer, ByteBuffer> grpc::GenericClientAsyncReaderWriter

GenericClientAsyncResponseReader

typedef ::grpc_impl::ClientAsyncResponseReader<ByteBuffer> grpc::GenericClientAsyncResponseReader

GenericServerAsyncReader

typedef ::grpc_impl::ServerAsyncReader<ByteBuffer, ByteBuffer> grpc::GenericServerAsyncReader

GenericServerAsyncReaderWriter

typedef ::grpc_impl::ServerAsyncReaderWriter<ByteBuffer, ByteBuffer> grpc::GenericServerAsyncReaderWriter

GenericServerAsyncResponseWriter

typedef ::grpc_impl::ServerAsyncResponseWriter<ByteBuffer> grpc::GenericServerAsyncResponseWriter

GenericServerAsyncWriter

typedef ::grpc_impl::ServerAsyncWriter<ByteBuffer> grpc::GenericServerAsyncWriter

GenericStub

typedef TemplatedGenericStub<grpc::ByteBuffer, grpc::ByteBuffer> grpc::GenericStub

Server

typedef ::grpc_impl::Server grpc::Server

ServerAsyncReader

template<class W , class R >

using grpc::ServerAsyncReader = typedef ::grpc_impl::ServerAsyncReader<W, R>

ServerAsyncReaderInterface

template<class W , class R >

using grpc::ServerAsyncReaderInterface = typedef ::grpc_impl::ServerAsyncReaderInterface<W, R>

ServerAsyncReaderWriter

template<class W , class R >

using grpc::ServerAsyncReaderWriter = typedef ::grpc_impl::ServerAsyncReaderWriter<W, R>

ServerAsyncReaderWriterInterface

template<class W , class R >

using grpc::ServerAsyncReaderWriterInterface = typedef ::grpc_impl::ServerAsyncReaderWriterInterface<W, R>

ServerAsyncResponseWriter

template<class W >

using grpc::ServerAsyncResponseWriter = typedef ::grpc_impl::ServerAsyncResponseWriter<W>

ServerAsyncWriter

template<class W >

using grpc::ServerAsyncWriter = typedef ::grpc_impl::ServerAsyncWriter<W>

ServerAsyncWriterInterface

template<class W >

using grpc::ServerAsyncWriterInterface = typedef ::grpc_impl::ServerAsyncWriterInterface<W>

ServerBuilderOption

typedef ::grpc_impl::ServerBuilderOption grpc::ServerBuilderOption

ServerContext

typedef ::grpc_impl::ServerContext grpc::ServerContext

ServerInitializer

typedef ::grpc_impl::ServerInitializer grpc::ServerInitializer

ServerReader

template<class R >

using grpc::ServerReader = typedef ::grpc_impl::ServerReader<R>

ServerReaderInterface

template<class R >

using grpc::ServerReaderInterface = typedef ::grpc_impl::ServerReaderInterface<R>

ServerReaderWriter

template<class W , class R >

using grpc::ServerReaderWriter = typedef ::grpc_impl::ServerReaderWriter<W, R>

ServerReaderWriterInterface

template<class W , class R >

using grpc::ServerReaderWriterInterface = typedef ::grpc_impl::ServerReaderWriterInterface<W, R>

ServerSplitStreamer

template<class RequestType , class ResponseType >

using grpc::ServerSplitStreamer = typedef ::grpc_impl::ServerSplitStreamer<RequestType, ResponseType>

ServerUnaryStreamer

template<class RequestType , class ResponseType >

using grpc::ServerUnaryStreamer = typedef ::grpc_impl::ServerUnaryStreamer<RequestType, ResponseType>

ServerWriter

template<class W >

using grpc::ServerWriter = typedef ::grpc_impl::ServerWriter<W>

ServerWriterInterface

template<class W >

using grpc::ServerWriterInterface = typedef ::grpc_impl::ServerWriterInterface<W>

Enumeration Type Documentation

StatusCode

enum grpc::StatusCode

Enumerator
OK	Not an error; returned on success.
CANCELLED	The operation was cancelled (typically by the caller).
UNKNOWN	Unknown error. An example of where this error may be returned is if a Status value received from another address space belongs to an error-space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error.
INVALID_ARGUMENT	Client specified an invalid argument. Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name).
DEADLINE_EXCEEDED	Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire.
NOT_FOUND	Some requested entity (e.g., file or directory) was not found.
ALREADY_EXISTS	Some entity that we attempted to create (e.g., file or directory) already exists.
PERMISSION_DENIED	The caller does not have permission to execute the specified operation. PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED instead for those errors). PERMISSION_DENIED must not be used if the caller can not be identified (use UNAUTHENTICATED instead for those errors).
UNAUTHENTICATED	The request does not have valid authentication credentials for the operation.
RESOURCE_EXHAUSTED	Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.
FAILED_PRECONDITION	Operation was rejected because the system is not in a state required for the operation's execution. For example, directory to be deleted may be non-empty, an rmdir operation is applied to a non-directory, etc. A litmus test that may help a service implementor in deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE: (a) Use UNAVAILABLE if the client can retry just the failing call. (b) Use ABORTED if the client should retry at a higher-level (e.g., restarting a read-modify-write sequence). (c) Use FAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. E.g., if an "rmdir" fails because the directory is non-empty, FAILED_PRECONDITION should be returned since the client should not retry unless they have first fixed up the directory by deleting files from it. (d) Use FAILED_PRECONDITION if the client performs conditional REST Get/Update/Delete on a resource and the resource on the server does not match the condition. E.g., conflicting read-modify-write on the same resource.
ABORTED	The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE.
OUT_OF_RANGE	Operation was attempted past the valid range. E.g., seeking or reading past end of file. Unlike INVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate INVALID_ARGUMENT if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OUT_OF_RANGE if asked to read from an offset past the current file size. There is a fair bit of overlap between FAILED_PRECONDITION and OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OUT_OF_RANGE error to detect when they are done.
UNIMPLEMENTED	Operation is not implemented or not supported/enabled in this service.
INTERNAL	Internal errors. Means some invariants expected by underlying System has been broken. If you see one of these errors, Something is very broken.
UNAVAILABLE	The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. Warning Although data MIGHT not have been transmitted when this status occurs, there is NOT A GUARANTEE that the server has not seen anything. So in general it is unsafe to retry on this status code if the call is non-idempotent. See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE.
DATA_LOSS	Unrecoverable data loss or corruption.
DO_NOT_USE	Force users to include a default branch:

Function Documentation

AccessTokenCredentials()

std::shared_ptr<CallCredentials> grpc::AccessTokenCredentials

(

const grpc::string &

access_token

)

Builds access token credentials.

access_token is an oauth2 access token that was fetched using an out of band mechanism.

Warning

Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services.

CompositeCallCredentials()

std::shared_ptr<CallCredentials> grpc::CompositeCallCredentials	(	const std::shared_ptr< CallCredentials > &	creds1,
		const std::shared_ptr< CallCredentials > &	creds2
	)

Combines two call credentials objects into a composite call credentials.

CompositeChannelCredentials()

std::shared_ptr<ChannelCredentials> grpc::CompositeChannelCredentials	(	const std::shared_ptr< ChannelCredentials > &	channel_creds,
		const std::shared_ptr< CallCredentials > &	call_creds
	)

Combines a channel credentials and a call credentials into a composite channel credentials.

CreateAuthContext()

std::shared_ptr<const AuthContext> grpc::CreateAuthContext

(

grpc_call *

call

)

CreateChannel()

std::shared_ptr<Channel> grpc::CreateChannel	(	const grpc::string &	target,
		const std::shared_ptr< ChannelCredentials > &	creds
	)

Create a new Channel pointing to target.

Parameters

target	The URI of the endpoint to connect to.
creds	Credentials to use for the created channel. If it does not hold an object or is invalid, a lame channel (one on which all operations fail) is returned.

CreateChannelInternal()

std::shared_ptr<Channel> grpc::CreateChannelInternal	(	const std::string &	host,
		grpc_channel *	c_channel,
		std::vector< std::unique_ptr< experimental::ClientInterceptorFactoryInterface >>	interceptor_creators
	)

CreateCustomChannel() [1/2]

std::shared_ptr<Channel> grpc::CreateCustomChannel	(	const grpc::string &	target,
		const std::shared_ptr< ChannelCredentials > &	creds,
		const ChannelArguments &	args
	)

Create a new custom Channel pointing to target.

Warning

For advanced use and testing ONLY. Override default channel arguments only if necessary.

Parameters

target	The URI of the endpoint to connect to.
creds	Credentials to use for the created channel. If it does not hold an object or is invalid, a lame channel (one on which all operations fail) is returned.
args	Options for channel creation.

CreateCustomChannel() [2/2]

std::shared_ptr<Channel> grpc::CreateCustomChannel	(	const grpc::string &	target,
		const std::shared_ptr< grpc::ChannelCredentials > &	creds,
		const grpc::ChannelArguments &	args
	)

DefaultHealthCheckServiceEnabled()

bool grpc::DefaultHealthCheckServiceEnabled

(

)

Returns whether the default health checking service is enabled.

NOT thread safe.

EnableDefaultHealthCheckService()

void grpc::EnableDefaultHealthCheckService

(

bool

enable

)

Enable/disable the default health checking service.

This applies to all C++ servers created afterwards. For each server, user can override the default with a HealthCheckServiceServerBuilderOption. NOT thread safe.

GenericDeserialize()

template<class ProtoBufferReader , class T >

Status grpc::GenericDeserialize	(	ByteBuffer *	buffer,
		grpc::protobuf::MessageLite *	msg
	)

GenericSerialize()

template<class ProtoBufferWriter , class T >

Status grpc::GenericSerialize	(	const grpc::protobuf::MessageLite &	msg,
		ByteBuffer *	bb,
		bool *	own_buffer
	)

GoogleComputeEngineCredentials()

std::shared_ptr<CallCredentials> grpc::GoogleComputeEngineCredentials

(

)

Builds credentials for use when running in GCE.

Warning

Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services.

GoogleDefaultCredentials()

std::shared_ptr<ChannelCredentials> grpc::GoogleDefaultCredentials

(

)

Builds credentials with reasonable defaults.

Warning

Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services.

GoogleIAMCredentials()

std::shared_ptr<CallCredentials> grpc::GoogleIAMCredentials	(	const grpc::string &	authorization_token,
		const grpc::string &	authority_selector
	)

Builds IAM credentials.

Warning

Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services.

GoogleRefreshTokenCredentials()

std::shared_ptr<CallCredentials> grpc::GoogleRefreshTokenCredentials

(

const grpc::string &

json_refresh_token

)

Builds refresh token credentials.

json_refresh_token is the JSON string containing the refresh token along with a client_id and client_secret.

Warning

Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services.

InsecureChannelCredentials()

std::shared_ptr<ChannelCredentials> grpc::InsecureChannelCredentials

(

)

Credentials for an unencrypted, unauthenticated channel.

InsecureServerCredentials()

std::shared_ptr<ServerCredentials> grpc::InsecureServerCredentials

(

)

MakeChannelArgumentOption() [1/2]

std::unique_ptr<ServerBuilderOption> grpc::MakeChannelArgumentOption	(	const std::string &	name,
		const std::string &	value
	)

MakeChannelArgumentOption() [2/2]

std::unique_ptr<ServerBuilderOption> grpc::MakeChannelArgumentOption	(	const std::string &	name,
		int	value
	)

MetadataCredentialsFromPlugin()

std::shared_ptr<CallCredentials> grpc::MetadataCredentialsFromPlugin

(

std::unique_ptr< MetadataCredentialsPlugin >

plugin

)

operator!=()

bool grpc::operator!= ( string_ref  x, string_ref  y  )

inline

operator<()

bool grpc::operator< ( string_ref  x, string_ref  y  )

inline

operator<<()

std::ostream& grpc::operator<< ( std::ostream &  out, const string_ref &  string  )

inline

operator<=()

bool grpc::operator<= ( string_ref  x, string_ref  y  )

inline

operator==()

bool grpc::operator== ( string_ref  x, string_ref  y  )

inline

Comparison operators.

operator>()

bool grpc::operator> ( string_ref  x, string_ref  y  )

inline

operator>=()

bool grpc::operator>= ( string_ref  x, string_ref  y  )

inline

ServiceAccountJWTAccessCredentials()

std::shared_ptr<CallCredentials> grpc::ServiceAccountJWTAccessCredentials	(	const grpc::string &	json_key,
		long	token_lifetime_seconds = kMaxAuthTokenLifetimeSecs
	)

Builds Service Account JWT Access credentials.

json_key is the JSON key string containing the client's private key. token_lifetime_seconds is the lifetime in seconds of each Json Web Token (JWT) created with this credentials. It should not exceed kMaxAuthTokenLifetimeSecs or will be cropped to this value.

SliceFromCopiedString()

grpc_slice grpc::SliceFromCopiedString ( const std::string &  str )

inline

SliceReferencingString()

grpc_slice grpc::SliceReferencingString ( const std::string &  str )

inline

SslCredentials()

std::shared_ptr<ChannelCredentials> grpc::SslCredentials

(

const SslCredentialsOptions &

options

)

Builds SSL Credentials given SSL specific options.

SslServerCredentials()

std::shared_ptr<ServerCredentials> grpc::SslServerCredentials

(

const grpc::SslServerCredentialsOptions &

options

)

Builds SSL ServerCredentials given SSL specific options.

StringFromCopiedSlice()

std::string grpc::StringFromCopiedSlice ( grpc_slice  slice )

inline

StringRefFromSlice()

grpc::string_ref grpc::StringRefFromSlice ( const grpc_slice *  slice )

inline

Timepoint2Timespec()

void grpc::Timepoint2Timespec	(	const std::chrono::system_clock::time_point &	from,
		gpr_timespec *	to
	)

TimepointHR2Timespec()

void grpc::TimepointHR2Timespec	(	const std::chrono::high_resolution_clock::time_point &	from,
		gpr_timespec *	to
	)

Timespec2Timepoint()

std::chrono::system_clock::time_point grpc::Timespec2Timepoint

(

gpr_timespec

t

)

Version()

std::string grpc::Version

(

)

Return gRPC library version.

Variable Documentation

g_core_codegen_interface

CoreCodegenInterface * grpc::g_core_codegen_interface

g_glip

GrpcLibraryInterface* grpc::g_glip

Initialized by grpc::GrpcLibraryInitializer from <grpcpp/impl/grpc_library.h>

kHealthCheckServiceInterfaceArg

const char grpc::kHealthCheckServiceInterfaceArg[]

Initial value:

=
    "grpc.health_check_service_interface"

kMaxAuthTokenLifetimeSecs

constexpr long grpc::kMaxAuthTokenLifetimeSecs = 3600

constexpr

kProtoBufferWriterMaxBufferLength

const int grpc::kProtoBufferWriterMaxBufferLength = 1024 * 1024