mirror of
https://fuchsia.googlesource.com/third_party/grpc
synced 2024-09-20 19:36:13 +00:00
1ed15e287c
Also properly including our headers from public headers using <>
104 lines
4.3 KiB
C
104 lines
4.3 KiB
C
/*
|
|
*
|
|
* 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.
|
|
*
|
|
*/
|
|
|
|
/* RPC-internal Census API's. These are designed to be generic enough that
|
|
* they can (ultimately) be used in many different RPC systems (with differing
|
|
* implementations). */
|
|
|
|
#ifndef CENSUS_CENSUS_H
|
|
#define CENSUS_CENSUS_H
|
|
|
|
#include <grpc/grpc.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Identify census functionality that can be enabled via census_initialize(). */
|
|
enum census_functions {
|
|
CENSUS_NONE = 0, /* Do not enable census. */
|
|
CENSUS_TRACING = 1, /* Enable census tracing. */
|
|
CENSUS_STATS = 2, /* Enable Census stats collection. */
|
|
CENSUS_CPU = 4, /* Enable Census CPU usage collection. */
|
|
CENSUS_ALL = CENSUS_TRACING | CENSUS_STATS | CENSUS_CPU
|
|
};
|
|
|
|
/* Shutdown and startup census subsystem. The 'functions' argument should be
|
|
* the OR (|) of census_functions values. If census fails to initialize, then
|
|
* census_initialize() will return a non-zero value. It is an error to call
|
|
* census_initialize() more than once (without an intervening
|
|
* census_shutdown()). */
|
|
int census_initialize(int functions);
|
|
void census_shutdown();
|
|
|
|
/* Internally, Census relies on a context, which should be propagated across
|
|
* RPC's. From the RPC subsystems viewpoint, this is an opaque data structure.
|
|
* A context must be used as the first argument to all other census
|
|
* functions. Conceptually, contexts should be thought of as specific to
|
|
* single RPC/thread. The context can be serialized for passing across the
|
|
* wire. */
|
|
typedef struct census_context census_context;
|
|
|
|
/* This function is called by the RPC subsystem whenever it needs to get a
|
|
* serialized form of the current census context (presumably to pass across
|
|
* the wire). Arguments:
|
|
* 'buffer': pointer to memory into which serialized context will be placed
|
|
* 'buf_size': size of 'buffer'
|
|
*
|
|
* Returns: the number of bytes used in buffer if successful, or 0 if the
|
|
* buffer is of insufficient size.
|
|
*
|
|
* TODO(aveitch): determine how best to communicate required/max buffer size
|
|
* so caller doesn't have to guess. */
|
|
size_t census_context_serialize(const census_context *context, char *buffer,
|
|
size_t buf_size);
|
|
|
|
/* Create a new census context, possibly from a serialized buffer. If 'buffer'
|
|
* is non-NULL, it is assumed that it is a buffer encoded by
|
|
* census_context_serialize(). If `buffer` is NULL, a new, empty context is
|
|
* created. The decoded/new contest is returned in 'context'.
|
|
*
|
|
* Returns 0 if no errors, non-zero if buffer is incorrectly formatted, in
|
|
* which case a new empty context will be returned. */
|
|
int census_context_deserialize(const char *buffer, census_context **context);
|
|
|
|
/* The given context is destroyed. Once destroyed, using the context in
|
|
* future census calls will result in undefined behavior. */
|
|
void census_context_destroy(census_context *context);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* CENSUS_CENSUS_H */
|