forked from toolshed/abra
84 lines
2.2 KiB
Go
84 lines
2.2 KiB
Go
/*
|
|
*
|
|
* Copyright 2014 gRPC authors.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
*/
|
|
|
|
// Package peer defines various peer information associated with RPCs and
|
|
// corresponding utils.
|
|
package peer
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net"
|
|
"strings"
|
|
|
|
"google.golang.org/grpc/credentials"
|
|
)
|
|
|
|
// Peer contains the information of the peer for an RPC, such as the address
|
|
// and authentication information.
|
|
type Peer struct {
|
|
// Addr is the peer address.
|
|
Addr net.Addr
|
|
// LocalAddr is the local address.
|
|
LocalAddr net.Addr
|
|
// AuthInfo is the authentication information of the transport.
|
|
// It is nil if there is no transport security being used.
|
|
AuthInfo credentials.AuthInfo
|
|
}
|
|
|
|
// String ensures the Peer types implements the Stringer interface in order to
|
|
// allow to print a context with a peerKey value effectively.
|
|
func (p *Peer) String() string {
|
|
if p == nil {
|
|
return "Peer<nil>"
|
|
}
|
|
sb := &strings.Builder{}
|
|
sb.WriteString("Peer{")
|
|
if p.Addr != nil {
|
|
fmt.Fprintf(sb, "Addr: '%s', ", p.Addr.String())
|
|
} else {
|
|
fmt.Fprintf(sb, "Addr: <nil>, ")
|
|
}
|
|
if p.LocalAddr != nil {
|
|
fmt.Fprintf(sb, "LocalAddr: '%s', ", p.LocalAddr.String())
|
|
} else {
|
|
fmt.Fprintf(sb, "LocalAddr: <nil>, ")
|
|
}
|
|
if p.AuthInfo != nil {
|
|
fmt.Fprintf(sb, "AuthInfo: '%s'", p.AuthInfo.AuthType())
|
|
} else {
|
|
fmt.Fprintf(sb, "AuthInfo: <nil>")
|
|
}
|
|
sb.WriteString("}")
|
|
|
|
return sb.String()
|
|
}
|
|
|
|
type peerKey struct{}
|
|
|
|
// NewContext creates a new context with peer information attached.
|
|
func NewContext(ctx context.Context, p *Peer) context.Context {
|
|
return context.WithValue(ctx, peerKey{}, p)
|
|
}
|
|
|
|
// FromContext returns the peer information in ctx if it exists.
|
|
func FromContext(ctx context.Context) (p *Peer, ok bool) {
|
|
p, ok = ctx.Value(peerKey{}).(*Peer)
|
|
return
|
|
}
|