package grpcprocess

Import Path
	go.pact.im/x/grpcprocess (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 0 packages

Involved Source Files

	    client.go
	  d doc.go
		Package grpcprocess provides [process.Runner] wrappers for [grpc.ClientConn]
		and [grpc.Server].

	    server.go
Package-Level Type Names (total 3, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type ClientConn (interface)
		ClientConn is a process-managed gRPC client connection.

		Methods (total 3, all are exported)
			( ClientConn) Invoke(ctx context.Context, method string, args any, reply any, opts ...grpc.CallOption) error
				Invoke performs a unary RPC and returns after the response is received
				into reply.

			( ClientConn) NewStream(ctx context.Context, desc *grpc.StreamDesc, method string, opts ...grpc.CallOption) (grpc.ClientStream, error)
				NewStream begins a streaming RPC.

			( ClientConn) Run(ctx context.Context, callback process.Callback) error
				Run executes the process. Callback function is called when the
				process has been initialized and began execution. The process is
				interrupted if the callback returns or the given context expires.
				On termination the context passed to the callback is canceled.
				
				To make debugging easier, callback runs in the same goroutine where
				Run was invoked. Note though that this behavior currently is not
				supported by all existing Run implementations.
				
				It is safe to assume that callback is called at most once per Run
				invocation.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*client
		Implements (at least 2, both are exported)
			 ClientConn : go.pact.im/x/process.Runner
			 ClientConn : google.golang.org/grpc.ClientConnInterface
		As Outputs Of (at least one exported)
			func Client(connect ClientFunc) ClientConn

	 type ClientFunc (func)
		ClientFunc creates a gRPC client connection using the given context.

		As Inputs Of (at least one exported)
			func Client(connect ClientFunc) ClientConn

	/* one unexported ... *//* one unexported: */
	 type client (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			conn atomic.Pointer[grpc.ClientConn]
			connect ClientFunc
		Methods (total 4, in which 3 are exported)
			(*client) Invoke(ctx context.Context, method string, args, reply any, options ...grpc.CallOption) error
				Invoke implements [grpc.ClientConnInterface].

			(*client) NewStream(ctx context.Context, desc *grpc.StreamDesc, method string, options ...grpc.CallOption) (grpc.ClientStream, error)
				NewStream implements [grpc.ClientConnInterface].

			(*client) Run(ctx context.Context, callback process.Callback) error
				Run implements the [process.Runner] interface.

			/* one unexported ... *//* one unexported: */
			(*client) load() (*grpc.ClientConn, error)
		Implements (at least 3, all are exported)
			*client : ClientConn
			*client : go.pact.im/x/process.Runner
			*client : google.golang.org/grpc.ClientConnInterface


Package-Level Functions (total 2, both are exported)

	 func Client(connect ClientFunc) ClientConn
		Client returns a [ClientConn] that creates its underlying [grpc.ClientConn]
		using connect at application runtime.

	 func Server(srv *grpc.Server, lis net.Listener) process.Runner
		Server returns a [process.Runner] instance for the given gRPC server and
		network listener.

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)