net.dongliu.prettypb.rpc.common.PeerInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of prettypb-rpc Show documentation
proto rpc libs, compatible with proto-rpc-pro
There is a newer version: 0.3.5
/**
 *   Copyright 2010-2014 Peter Klauser
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
package net.dongliu.prettypb.rpc.common;

import java.net.InetSocketAddress;

/**
 * PeerInfo is a value-object which represents a communicating peer.
 *
 * The name of the PeerInfo represents a unique identifier of the Peer.
 * for TcpServer's this is the hostName and TCP port on which the server is bound.
 * for TcpClient's there is no local binding to a TCP port for incoming connection
 * listening, however we can still assign or name a port which is unique
 * for the client for naming purposes.
 *
 * The PID of the process in which the TcpClient or TcpServer peer is running.
 * The PID is used to ascertain if the process has restarted, in which case the
 * previous in-memory state of the peer is lost. The knowledge that the peer has lost
 * previous state is important in scenarios where data is duplicated on both peers, or
 * one peer remembers what another peer knows.
 *
 * @author Peter Klauser
 */
public class PeerInfo {

    private String hostName;
    private int port;
    private String pid;

    /**
     * A "floating" client PeerInfo which is not bound to any local port, and has a new
     * random pid.
     */
    public PeerInfo() {
        this(null, -1);
    }

    /**
     * A client PeerInfo which is not bound to any local port, but has a given pid.
     *
     * @param pid
     */
    public PeerInfo(String pid) {
        this(null, -1, pid);
    }

    /**
     * Constructor to construct a PeerInfo with a specific localAddress and processId.
     *
     * @param localAddress
     * @param pid
     */
    public PeerInfo(InetSocketAddress localAddress, String pid) {
        this(localAddress.getHostName(), localAddress.getPort(), pid);
    }

    /**
     * Constructor to construct a PeerInfo with a specific localAddress.
     * A Random processId will be assigned for this PeerInfo instance.
     *
     * @param localAddress
     */
    public PeerInfo(InetSocketAddress localAddress) {
        this(localAddress.getHostName(), localAddress.getPort());
    }

    /**
     * Constructor to construct a PeerInfo of one's own process.
     * A Random processId will be assigned for this PeerInfo instance.
     *
     * @param hostName
     * @param port
     */
    public PeerInfo(String hostName, int port) {
        this.hostName = hostName;
        this.port = port;
        this.pid = java.util.UUID.randomUUID().toString();
    }

    /**
     * Constructor used to construct a PeerInfo of some other process.
     *
     * @param hostName
     * @param port
     * @param pid
     */
    public PeerInfo(String hostName, int port, String pid) {
        this.hostName = hostName;
        this.port = port;
        this.pid = pid;
    }

    /**
     * The full PeerInfo description.
     */
    public String toString() {
        return getName() + "[" + getPid() + "]";
    }

    /**
     * Return the peer's name. Does not include PID, since the
     * peer name is constant over process restarts.
     *
     * @return hostName + ":" + port.
     */
    public String getName() {
        return getHostName() + ":" + getPort();
    }

    /**
     * @return the hostName
     */
    public String getHostName() {
        return hostName;
    }

    /**
     * @return the port
     */
    public int getPort() {
        return port;
    }

    /**
     * @return the pid
     */
    public String getPid() {
        return pid;
    }


}