grpc

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2023, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

Index

• func ClientDialOptions(disablePrintMethods ...string) []grpc.DialOption
• func GetGrpcClientConn(addr string, connectionTimeout time.Duration, disablePrintMethods ...string) (*grpc.ClientConn, error)
• func GetIPFromContext(ctx context.Context) (net.IP, error)
• type EmptyGrpcClientOption
• type Factory
  • func NewFactory[T any](fc FactoryConfig[T], configFuncs ...FactoryConfigFunc[T]) (Factory[T], error)
  • func (f Factory[T]) NewClient(ctx context.Context) (Repository[T], error)
• type FactoryConfig
  • func (fc *FactoryConfig[T]) ApplyOptions(configFuncs ...FactoryConfigFunc[T]) error
  • func (fc FactoryConfig[T]) Validate() error
• type FactoryConfigFunc
• type GrpcClient
  • func NewGrpcClient(addr string, options ...GrpcClientOption) (*GrpcClient, error)
  • func (o *GrpcClient) ApplyOptions(options ...GrpcClientOption) *GrpcClient
  • func (g *GrpcClient) Close() error
  • func (g *GrpcClient) Conn() *grpc.ClientConn
• type GrpcClientOption
  • func WithConnectionTimeout(connectionTimeout time.Duration) GrpcClientOption
  • func WithMaxMsgSize(maxMsgSize int) GrpcClientOption
• type GrpcClientOptionFunc
• type Repository
  • func (r *Repository[T]) Call(ctx context.Context, f func(ctx context.Context) error) (err error)
  • func (r *Repository[T]) Close(conn *grpc.ClientConn) (err error)
  • func (r *Repository[T]) NewConnect() (client T, conn *grpc.ClientConn, err error)

Functions

func ClientDialOptions

func ClientDialOptions(disablePrintMethods ...string) []grpc.DialOption

func GetGrpcClientConn

func GetGrpcClientConn(
	addr string,
	connectionTimeout time.Duration,
	disablePrintMethods ...string,
) (*grpc.ClientConn, error)

func GetIPFromContext

func GetIPFromContext(ctx context.Context) (net.IP, error)

returns IP address from grpc context. It will lookup IP in X-Forwarded-For and X-Real-IP headers, if both get empty, lookup IP from peer context

Types

type EmptyGrpcClientOption

type EmptyGrpcClientOption struct{}

EmptyGrpcClientOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type Factory

type Factory[T any] struct {
	// contains filtered or unexported fields
}

func NewFactory

func NewFactory[T any](fc FactoryConfig[T], configFuncs ...FactoryConfigFunc[T]) (Factory[T], error)

func (Factory[T]) NewClient

func (f Factory[T]) NewClient(ctx context.Context) (Repository[T], error)

type FactoryConfig

type FactoryConfig[T any] struct {
	Validator        *validator.Validate
	Addr             string
	Timeout          time.Duration //接口处理超时时间
	NewServiceClient func(*grpc.ClientConn) T

	// not include the first call
	RetryTimes    int
	RetryInterval time.Duration

	DisablePrintInoutMethods []string
}

func (*FactoryConfig[T]) ApplyOptions

func (fc *FactoryConfig[T]) ApplyOptions(configFuncs ...FactoryConfigFunc[T]) error

func (FactoryConfig[T]) Validate

func (fc FactoryConfig[T]) Validate() error

type FactoryConfigFunc

type FactoryConfigFunc[T any] func(c *FactoryConfig[T]) error

type GrpcClient

type GrpcClient struct {
	// contains filtered or unexported fields
}

func NewGrpcClient

func NewGrpcClient(addr string, options ...GrpcClientOption) (*GrpcClient, error)

func (*GrpcClient) ApplyOptions

func (o *GrpcClient) ApplyOptions(options ...GrpcClientOption) *GrpcClient

func (*GrpcClient) Close

func (g *GrpcClient) Close() error

func (*GrpcClient) Conn

func (g *GrpcClient) Conn() *grpc.ClientConn

type GrpcClientOption

type GrpcClientOption interface {
	// contains filtered or unexported methods
}

A GrpcClientOption sets options.

func WithConnectionTimeout

func WithConnectionTimeout(connectionTimeout time.Duration) GrpcClientOption

func WithMaxMsgSize

func WithMaxMsgSize(maxMsgSize int) GrpcClientOption

type GrpcClientOptionFunc

type GrpcClientOptionFunc func(*GrpcClient)

GrpcClientOptionFunc wraps a function that modifies Client into an implementation of the GrpcClientOption interface.

type Repository

type Repository[T any] struct {
	Timeout time.Duration

	Addr             string
	NewServiceClient func(*grpc.ClientConn) T
	Conn             *grpc.ClientConn
	Client           T

	// not include the first call
	RetryTimes    int
	RetryInterval time.Duration

	DisablePrintInoutMethods []string
}

func (*Repository[T]) Call

func (r *Repository[T]) Call(ctx context.Context, f func(ctx context.Context) error) (err error)

func (*Repository[T]) Close

func (r *Repository[T]) Close(conn *grpc.ClientConn) (err error)

func (*Repository[T]) NewConnect

func (r *Repository[T]) NewConnect() (client T, conn *grpc.ClientConn, err error)