grpcutils

Documentation

Index

• func HandleGrpcErr(err error, pluginCtx context.Context) error
• func HandleReqCtxGrpcErr(err error, reqCtx, pluginCtx context.Context) error

Functions

func HandleGrpcErr

func HandleGrpcErr(err error, pluginCtx context.Context) error

HandleGrpcErr is used to handle errors made to a remote gRPC plugin. It handles detecting if the plugin has shutdown via the passeed pluginCtx. The parameters are: - err: the error returned from the streaming RPC - pluginCtx: the plugins done ctx used to detect the plugin dying

The return values are: - ErrPluginShutdown if the error is because the plugin shutdown - The original error

func HandleReqCtxGrpcErr

func HandleReqCtxGrpcErr(err error, reqCtx, pluginCtx context.Context) error

HandleReqCtxGrpcErr is used to handle a non io.EOF error in a GRPC request where a user supplied context is used. It handles detecting if the plugin has shutdown via the passeed pluginCtx. The parameters are: - err: the error returned from the streaming RPC - reqCtx: the user context passed to the request - pluginCtx: the plugins done ctx used to detect the plugin dying

The return values are: - ErrPluginShutdown if the error is because the plugin shutdown - context.Canceled if the reqCtx is canceled - The original error