org.ros.internal.transport.tcp.TcpClientManager.java Source code

Introduction

Here is the source code for org.ros.internal.transport.tcp.TcpClientManager.java

Source

/*
 * Copyright (C) 2011 Google Inc.
 *
 * 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 org.ros.internal.transport.tcp;

import com.google.common.collect.Lists;

import org.jboss.netty.channel.Channel;
import org.jboss.netty.channel.group.ChannelGroup;
import org.jboss.netty.channel.group.DefaultChannelGroup;
import org.jboss.netty.util.HashedWheelTimer;

import java.net.SocketAddress;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.Executor;

/**
 * @author damonkohler@google.com (Damon Kohler)
 */
public class TcpClientManager {

    private final ChannelGroup channelGroup;
    private final Collection<TcpClient> tcpClients;
    private final List<NamedChannelHandler> namedChannelHandlers;
    private final Executor executor;
    private final HashedWheelTimer nettyTimer;

    public TcpClientManager(Executor executor) {
        this.executor = executor;
        nettyTimer = new HashedWheelTimer();

        channelGroup = new DefaultChannelGroup();
        tcpClients = Lists.newCopyOnWriteArrayList();
        namedChannelHandlers = Lists.newArrayList();
    }

    public void addNamedChannelHandler(NamedChannelHandler namedChannelHandler) {
        namedChannelHandlers.add(namedChannelHandler);
    }

    public void addAllNamedChannelHandlers(List<NamedChannelHandler> namedChannelHandlers) {
        this.namedChannelHandlers.addAll(namedChannelHandlers);
    }

    /**
     * Connects to a server.
     * <p>
     * This call blocks until the connection is established or fails.
     *
     * @param connectionName
     *          the name of the new connection
     * @param socketAddress
     *          the {@link SocketAddress} to connect to
     * @return a new {@link TcpClient}
     */
    public TcpClient connect(String connectionName, SocketAddress socketAddress) {
        TcpClient tcpClient = new TcpClient(channelGroup, nettyTimer, executor);
        tcpClient.addAllNamedChannelHandlers(namedChannelHandlers);
        tcpClient.connect(connectionName, socketAddress);
        tcpClients.add(tcpClient);
        return tcpClient;
    }

    /**
     * Shuts down all {@link TcpClient}s and closes all open {@link Channel}s.
     */
    public void shutdown() {
        channelGroup.close().awaitUninterruptibly();

        // Shut down each client. This will free up many of their resources.
        for (TcpClient client : tcpClients) {
            client.shutdown();
        }
        tcpClients.clear();

        nettyTimer.stop();
    }
}