package keepalive

Import Path
	google.golang.org/grpc/keepalive (on go.dev)

Dependency Relation
	imports one package, and imported by 2 packages

Involved Source Files

	   #d keepalive.go
		Package keepalive defines configurable parameters for point-to-point
		healthcheck.
Package-Level Type Names (total 3, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type ClientParameters (struct)
		ClientParameters is used to set keepalive parameters on the client-side.
		These configure how the client will actively probe to notice when a
		connection is broken and send pings so intermediaries will be aware of the
		liveness of the connection. Make sure these parameters are set in
		coordination with the keepalive policy on the server, as incompatible
		settings can result in closing of connection.

		Fields (total 3, all are exported)
			PermitWithoutStream bool
				If true, client sends keepalive pings even with no active RPCs. If false,
				when there are no active RPCs, Time and Timeout will be ignored and no
				keepalive pings will be sent.
				// false by default.

			Time time.Duration
				After a duration of this time if the client doesn't see any activity it
				pings the server to see if the transport is still alive.
				If set below 10s, a minimum value of 10s will be used instead.
				// The current default value is infinity.

			Timeout time.Duration
				After having pinged for keepalive check, the client waits for a duration
				of Timeout and if no activity is seen even after that the connection is
				closed.
				// The current default value is 20 seconds.

		As Inputs Of (at least one exported)
			func google.golang.org/grpc.WithKeepaliveParams(kp ClientParameters) grpc.DialOption

	 type EnforcementPolicy (struct)
		EnforcementPolicy is used to set keepalive enforcement policy on the
		server-side. Server will close connection with a client that violates this
		policy.

		Fields (total 2, both are exported)
			MinTime time.Duration
				MinTime is the minimum amount of time a client should wait before sending
				a keepalive ping.
				// The current default value is 5 minutes.

			PermitWithoutStream bool
				If true, server allows keepalive pings even when there are no active
				streams(RPCs). If false, and client sends ping when there are no active
				streams, server will send GOAWAY and close the connection.
				// false by default.

		As Inputs Of (at least one exported)
			func google.golang.org/grpc.KeepaliveEnforcementPolicy(kep EnforcementPolicy) grpc.ServerOption

	 type ServerParameters (struct)
		ServerParameters is used to set keepalive and max-age parameters on the
		server-side.

		Fields (total 5, all are exported)
			MaxConnectionAge time.Duration
				MaxConnectionAge is a duration for the maximum amount of time a
				connection may exist before it will be closed by sending a GoAway. A
				random jitter of +/-10% will be added to MaxConnectionAge to spread out
				connection storms.
				// The current default value is infinity.

			MaxConnectionAgeGrace time.Duration
				MaxConnectionAgeGrace is an additive period after MaxConnectionAge after
				which the connection will be forcibly closed.
				// The current default value is infinity.

			MaxConnectionIdle time.Duration
				MaxConnectionIdle is a duration for the amount of time after which an
				idle connection would be closed by sending a GoAway. Idleness duration is
				defined since the most recent time the number of outstanding RPCs became
				zero or the connection establishment.
				// The current default value is infinity.

			Time time.Duration
				After a duration of this time if the server doesn't see any activity it
				pings the client to see if the transport is still alive.
				If set below 1s, a minimum value of 1s will be used instead.
				// The current default value is 2 hours.

			Timeout time.Duration
				After having pinged for keepalive check, the server waits for a duration
				of Timeout and if no activity is seen even after that the connection is
				closed.
				// The current default value is 20 seconds.

		As Inputs Of (at least one exported)
			func google.golang.org/grpc.KeepaliveParams(kp ServerParameters) grpc.ServerOption

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