Skip to content

Commit

Permalink
Revisit the documentation of the Member interface.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nils Dijk committed Nov 30, 2016
1 parent 28c26a5 commit 7d33825
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions membership/interface.go
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
package membership

// Member defines a member of the membership that can be used by the rest of the
// system
// Member defines a member of the membership. It can be used by applications to
// apply specific business logic on Members. Examples are:
// - Get the address of a member for RPC calls, both forwarding of internal
// calls that should target a Member
// - Decissions to include a Member in a query via predicates.
type Member interface {
// GetAddress returns the external address used by the rpc layer to
// communicate to the member. It is prefixed with Get for legacy reasons and
// can be removed after a refactor of the swim.Member
// communicate to the member.
//
// Note: It is prefixed with Get for legacy reasons and can be removed after
// a refactor of the swim.Member to free up the `Address` name.
GetAddress() string

// Label reads the label for a given key from the member. It also returns
Expand Down

0 comments on commit 7d33825

Please sign in to comment.