ZeroTierOne/java/src/com/zerotier/sdk/Peer.java

/*
 * ZeroTier One - Network Virtualization Everywhere
 * Copyright (C) 2011-2015  ZeroTier, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * --
 *
 * ZeroTier may be used and distributed under the terms of the GPLv3, which
 * are available at: http://www.gnu.org/licenses/gpl-3.0.html
 *
 * If you would like to embed ZeroTier into a commercial application or
 * redistribute it in a modified binary form, please contact ZeroTier Networks
 * LLC. Start here: http://www.zerotier.com/
 */

package com.zerotier.sdk;

import java.util.ArrayList;

/**
 * Peer status result
 */
public final class Peer {
    private long address;
    private long lastUnicastFrame;
    private long lastMulticastFrame;
    private int versionMajor;
    private int versionMinor;
    private int versionRev;
    private int latency;
    private PeerRole role;
    private ArrayList<PeerPhysicalPath> paths;

    private Peer() {}

    /**
     * ZeroTier address (40 bits)
     */
    public final long address() {
        return address;
    }

    /**
     * Time we last received a unicast frame from this peer
     */
    public final long lastUnicastFrame() {
        return lastUnicastFrame;
    }

    /**
     * Time we last received a multicast rame from this peer
     */
    public final long lastMulticastFrame() {
        return lastMulticastFrame;
    }

    /**
     * Remote major version or -1 if not known
     */
    public final int versionMajor() {
        return versionMajor;
    }

    /**
     * Remote minor version or -1 if not known
     */
    public final int versionMinor() {
        return versionMinor;
    }

    /**
     * Remote revision or -1 if not known
     */
    public final int versionRev() {
        return versionRev;
    }

    /**
     * Last measured latency in milliseconds or zero if unknown
     */
    public final int latency() {
        return latency;
    }

    /**
     * What trust hierarchy role does this device have?
     */
    public final PeerRole role() {
        return role;
    }

    /**
     * Known network paths to peer
     */
    public final ArrayList<PeerPhysicalPath> paths() {
        return paths;
    }
}