go.temporal.io/server@v1.23.0/common/membership/hostinfo.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package membership
    26  
    27  // HostInfo represents the host of a Temporal service.
    28  type HostInfo interface {
    29  	// Identity returns the unique identifier of the host.
    30  	// This may be the same as the address.
    31  	Identity() string
    32  	// GetAddress returns the socket address of the host (i.e. <ip>:<port>).
    33  	// This must be a valid gRPC address.
    34  	GetAddress() string
    35  }
    36  
    37  // NewHostInfoFromAddress creates a new HostInfo instance from a socket address.
    38  func NewHostInfoFromAddress(address string) HostInfo {
    39  	return hostAddress(address)
    40  }
    41  
    42  // hostAddress is a HostInfo implementation that uses a string as the address and identity.
    43  type hostAddress string
    44  
    45  // GetAddress returns the value of the hostAddress.
    46  func (a hostAddress) GetAddress() string {
    47  	return string(a)
    48  }
    49  
    50  // Identity returns the value of the hostAddress.
    51  func (a hostAddress) Identity() string {
    52  	return string(a)
    53  }