remoteaddr

Documentation

Overview

Package remoteaddr gets the gRPC client's remote address.

Index

• Variables
• func GetFromContext(ctx context.Context) (net.Addr, error)
• func GetIPFromContext(ctx context.Context) (net.IP, error)

Examples

• GetFromContext

Variables

var (
	// ErrNotAvailable is returned when the remote client address is not available
	ErrNotAvailable = errors.New("remote address is not available")
)

Functions

func GetFromContext

func GetFromContext(ctx context.Context) (net.Addr, error)

GetFromContext returns the remote address of the client calling the method, for both unary and streaming method, in a gRPC call context. ErrNotAvailable is returned if remote address is not available.

Example

ExampleGetFromContext show how to get the remote address from client

package main

import (
	"context"
	"fmt"

	"github.com/jucrouzet/grpcutils/pkg/remoteaddr"
)

// ExampleGetFromContext show how to get the remote address from client
func main() {
	addr, err := remoteaddr.GetFromContext(ctx)

	if err != nil {
		// There was an error while getting the remote address
	}
	// addr is now client's remote address
	fmt.Println(addr)
}

var ctx context.Context

func GetIPFromContext

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

GetIPFromContext returns the remote ip of the client calling the method, for both unary and streaming method, in a gRPC call context. ErrNotAvailable is returned if remote address is not available.