2016-06-07 21:30:43 +00:00
|
|
|
/*
|
|
|
|
*
|
|
|
|
* Copyright 2016, 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.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
package grpc
|
|
|
|
|
|
|
|
import (
|
|
|
|
"golang.org/x/net/context"
|
|
|
|
)
|
|
|
|
|
2016-10-20 18:26:04 +00:00
|
|
|
// UnaryInvoker is called by UnaryClientInterceptor to complete RPCs.
|
|
|
|
type UnaryInvoker func(ctx context.Context, method string, req, reply interface{}, cc *ClientConn, opts ...CallOption) error
|
|
|
|
|
|
|
|
// UnaryClientInterceptor intercepts the execution of a unary RPC on the client. inovker is the handler to complete the RPC
|
|
|
|
// and it is the responsibility of the interceptor to call it.
|
|
|
|
// This is the EXPERIMENTAL API.
|
|
|
|
type UnaryClientInterceptor func(ctx context.Context, method string, req, reply interface{}, cc *ClientConn, invoker UnaryInvoker, opts ...CallOption) error
|
|
|
|
|
|
|
|
// Streamer is called by StreamClientInterceptor to create a ClientStream.
|
|
|
|
type Streamer func(ctx context.Context, desc *StreamDesc, cc *ClientConn, method string, opts ...CallOption) (ClientStream, error)
|
|
|
|
|
|
|
|
// StreamClientInterceptor intercepts the creation of ClientStream. It may return a custom ClientStream to intercept all I/O
|
|
|
|
// operations. streamer is the handlder to create a ClientStream and it is the responsibility of the interceptor to call it.
|
|
|
|
// This is the EXPERIMENTAL API.
|
|
|
|
type StreamClientInterceptor func(ctx context.Context, desc *StreamDesc, cc *ClientConn, method string, streamer Streamer, opts ...CallOption) (ClientStream, error)
|
|
|
|
|
2016-06-07 21:30:43 +00:00
|
|
|
// UnaryServerInfo consists of various information about a unary RPC on
|
|
|
|
// server side. All per-rpc information may be mutated by the interceptor.
|
|
|
|
type UnaryServerInfo struct {
|
|
|
|
// Server is the service implementation the user provides. This is read-only.
|
|
|
|
Server interface{}
|
|
|
|
// FullMethod is the full RPC method string, i.e., /package.service/method.
|
|
|
|
FullMethod string
|
|
|
|
}
|
|
|
|
|
|
|
|
// UnaryHandler defines the handler invoked by UnaryServerInterceptor to complete the normal
|
|
|
|
// execution of a unary RPC.
|
|
|
|
type UnaryHandler func(ctx context.Context, req interface{}) (interface{}, error)
|
|
|
|
|
|
|
|
// UnaryServerInterceptor provides a hook to intercept the execution of a unary RPC on the server. info
|
|
|
|
// contains all the information of this RPC the interceptor can operate on. And handler is the wrapper
|
|
|
|
// of the service method implementation. It is the responsibility of the interceptor to invoke handler
|
|
|
|
// to complete the RPC.
|
|
|
|
type UnaryServerInterceptor func(ctx context.Context, req interface{}, info *UnaryServerInfo, handler UnaryHandler) (resp interface{}, err error)
|
|
|
|
|
|
|
|
// StreamServerInfo consists of various information about a streaming RPC on
|
|
|
|
// server side. All per-rpc information may be mutated by the interceptor.
|
|
|
|
type StreamServerInfo struct {
|
|
|
|
// FullMethod is the full RPC method string, i.e., /package.service/method.
|
|
|
|
FullMethod string
|
|
|
|
// IsClientStream indicates whether the RPC is a client streaming RPC.
|
|
|
|
IsClientStream bool
|
|
|
|
// IsServerStream indicates whether the RPC is a server streaming RPC.
|
|
|
|
IsServerStream bool
|
|
|
|
}
|
|
|
|
|
|
|
|
// StreamServerInterceptor provides a hook to intercept the execution of a streaming RPC on the server.
|
|
|
|
// info contains all the information of this RPC the interceptor can operate on. And handler is the
|
|
|
|
// service method implementation. It is the responsibility of the interceptor to invoke handler to
|
|
|
|
// complete the RPC.
|
|
|
|
type StreamServerInterceptor func(srv interface{}, ss ServerStream, info *StreamServerInfo, handler StreamHandler) error
|