peer.go 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. /*
  2. *
  3. * Copyright 2014 gRPC authors.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. *
  17. */
  18. // Package peer defines various peer information associated with RPCs and
  19. // corresponding utils.
  20. package peer
  21. import (
  22. "context"
  23. "net"
  24. "google.golang.org/grpc/credentials"
  25. )
  26. // Peer contains the information of the peer for an RPC, such as the address
  27. // and authentication information.
  28. type Peer struct {
  29. // Addr is the peer address.
  30. Addr net.Addr
  31. // AuthInfo is the authentication information of the transport.
  32. // It is nil if there is no transport security being used.
  33. AuthInfo credentials.AuthInfo
  34. }
  35. type peerKey struct{}
  36. // NewContext creates a new context with peer information attached.
  37. func NewContext(ctx context.Context, p *Peer) context.Context {
  38. return context.WithValue(ctx, peerKey{}, p)
  39. }
  40. // FromContext returns the peer information in ctx if it exists.
  41. func FromContext(ctx context.Context) (p *Peer, ok bool) {
  42. p, ok = ctx.Value(peerKey{}).(*Peer)
  43. return
  44. }