github.com/blixtra/rkt@v0.8.1-0.20160204105720-ab0d1add1a43/Godeps/_workspace/src/google.golang.org/grpc/peer/peer.go (about)

     1  /*
     2   *
     3   * Copyright 2014, Google Inc.
     4   * All rights reserved.
     5   *
     6   * Redistribution and use in source and binary forms, with or without
     7   * modification, are permitted provided that the following conditions are
     8   * met:
     9   *
    10   *     * Redistributions of source code must retain the above copyright
    11   * notice, this list of conditions and the following disclaimer.
    12   *     * Redistributions in binary form must reproduce the above
    13   * copyright notice, this list of conditions and the following disclaimer
    14   * in the documentation and/or other materials provided with the
    15   * distribution.
    16   *     * Neither the name of Google Inc. nor the names of its
    17   * contributors may be used to endorse or promote products derived from
    18   * this software without specific prior written permission.
    19   *
    20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    21   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    22   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    23   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    24   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    25   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    26   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    27   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    28   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    29   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    30   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    31   *
    32   */
    33  
    34  // Package peer defines various peer information associated with RPCs and
    35  // corresponding utils.
    36  package peer
    37  
    38  import (
    39  	"net"
    40  
    41  	"golang.org/x/net/context"
    42  	"google.golang.org/grpc/credentials"
    43  )
    44  
    45  // Peer contains the information of the peer for an RPC.
    46  type Peer struct {
    47  	// Addr is the peer address.
    48  	Addr net.Addr
    49  	// AuthInfo is the authentication information of the transport.
    50  	// It is nil if there is no transport security being used.
    51  	AuthInfo credentials.AuthInfo
    52  }
    53  
    54  type peerKey struct{}
    55  
    56  // NewContext creates a new context with peer information attached.
    57  func NewContext(ctx context.Context, p *Peer) context.Context {
    58  	return context.WithValue(ctx, peerKey{}, p)
    59  }
    60  
    61  // FromContext returns the peer information in ctx if it exists.
    62  func FromContext(ctx context.Context) (p *Peer, ok bool) {
    63  	p, ok = ctx.Value(peerKey{}).(*Peer)
    64  	return
    65  }