org.drasyl.event.PeerRelayEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of drasyl-core Show documentation

This packages contains the building blocks required to create the drasyl overlay network.

There is a newer version: 0.10.0

/*
 * Copyright (c) 2020-2021 Heiko Bornholdt and Kevin Röbert
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
 * OR OTHER DEALINGS IN THE SOFTWARE.
 */
package org.drasyl.event;

import com.google.auto.value.AutoValue;

/**
 * This event signals that communication with this peer is only possible by relaying messages via a
 * super peer. If there is no connection to a super peer, no communication with this peer is
 * possible.
 * 
 * This is an immutable object.
 *
 * @see PeerDirectEvent
 * @see NodeOnlineEvent
 * @see NodeOfflineEvent
 */
@AutoValue
@SuppressWarnings("java:S118")
public abstract class PeerRelayEvent implements PeerEvent {
    /**
     * @throws NullPointerException if {@code peer} is {@code null}
     */
    public static PeerRelayEvent of(final Peer peer) {
        return new AutoValue_PeerRelayEvent(peer);
    }
}