go.uber.org/yarpc@v1.72.1/peer/x/peerheap/score.go (about)

     1  // Copyright (c) 2022 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package peerheap
    22  
    23  import "go.uber.org/yarpc/api/peer"
    24  
    25  // peerScore is a book-keeping object for each retained peer and
    26  // gets
    27  type peerScore struct {
    28  	// immutable after creation
    29  	peer        peer.Peer
    30  	id          peer.Identifier
    31  	list        *List
    32  	boundFinish func(error)
    33  
    34  	status peer.Status
    35  	score  int64
    36  	idx    int // index in the peer list.
    37  	last   int // snapshot of the heap's incrementing counter.
    38  }
    39  
    40  func (ps *peerScore) NotifyStatusChanged(_ peer.Identifier) {
    41  	if ps == nil || ps.list == nil {
    42  		// The subscriber is no longer retained by the peer list, or caller
    43  		// obtained a nil subscriber (happens in tests).
    44  		return
    45  	}
    46  	status := ps.peer.Status()
    47  	if ps.status == status {
    48  		return
    49  	}
    50  	ps.status = status
    51  	ps.list.peerScoreChanged(ps)
    52  }
    53  
    54  func (ps *peerScore) finish(error) {
    55  	ps.peer.EndRequest()
    56  }