ConnectionBean.java

/*
 * Copyright 2013 Thomas Bocek
 *
 * 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.tomp2p.connection2;

import java.util.Timer;

/**
 * A bean that holds sharable configuration settings for the peer. The non-sharable configurations are stored in
 * {@link PeerBean}.
 * 
 * @author Thomas Bocek
 */
public class ConnectionBean {

    /**
     * The thread name is important to identify threads where blocking (wait) is possible.
     */
    public static final String THREAD_NAME = "NETTY-TOMP2P - ";
    public static final int DEFAULT_TCP_IDLE_SECONDS = 5;
    public static final int DEFAULT_UDP_IDLE_SECONDS = 5;
    public static final int DEFAULT_CONNECTION_TIMEOUT_TCP = 3000;
    public static final int UDP_LIMIT = 1400;

    private final int p2pId;
    private final Dispatcher dispatcher;
    private final Sender sender;
    private final ChannelServer channelServer;
    private final Reservation reservation;
    private final ChannelClientConfiguration resourceConfiguration;
    private final NATUtils natUtils;
    private final Timer timer;

    /**
     * The connection bean with unmodifiable objects. Once its set you cannot change it. If its required to change, then
     * shutdown the peer and create a new one.
     * 
     * @param p2pId
     *            The P2P id
     * @param dispatcher
     *            The dispatcher object that receives all messages
     * @param sender
     *            The sender object that sends out messages
     * @param channelServer
     *            The channel server that listens on incoming connections
     * @param reservation
     *            The connection reservation that is responsible for resource management
     * @param resourceConfiguration
     *            The configuration that is responsible for the resource numbers
     * @param natUtils
     *            The NAT helper tools
     * @param timer
     *            The timer for the discovery process
     */
    public ConnectionBean(final int p2pId, final Dispatcher dispatcher, final Sender sender,
            final ChannelServer channelServer, final Reservation reservation,
            final ChannelClientConfiguration resourceConfiguration, final NATUtils natUtils, final Timer timer) {
        this.p2pId = p2pId;
        this.dispatcher = dispatcher;
        this.sender = sender;
        this.channelServer = channelServer;
        this.reservation = reservation;
        this.resourceConfiguration = resourceConfiguration;
        this.natUtils = natUtils;
        this.timer = timer;
    }

    /**
     * @return The P2P id
     */
    public int p2pId() {
        return p2pId;
    }

    /**
     * @return The dispatcher object that receives all messages
     */
    public Dispatcher dispatcher() {
        return dispatcher;
    }

    /**
     * @return The sender object that sends out messages
     */
    public Sender sender() {
        return sender;
    }

    /**
     * @return The channel server that listens on incoming connections
     */
    public ChannelServer channelServer() {
        return channelServer;
    }

    /**
     * @return The connection reservation that is responsible for resource management
     */
    public Reservation reservation() {
        return reservation;
    }

    /**
     * @return The configuration that is responsible for the resource numbers
     */
    public ChannelClientConfiguration resourceConfiguration() {
        return resourceConfiguration;
    }

    /**
     * @return The NAT helper tools
     */
    public NATUtils natUtils() {
        return natUtils;
    }

    /**
     * @return The timer used for the discovery
     */
    public Timer timer() {
        return timer;
    }
}