001/*
002 * JGrapes Event Driven Framework
003 * Copyright (C) 2016-2018 Michael N. Lipp
004 * 
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Affero General Public License as published by 
007 * the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 * 
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Affero General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jgrapes.net.events;
020
021import java.net.SocketAddress;
022import org.jgrapes.io.events.OpenTcpConnection;
023
024/**
025 * This event signals that a new connection has been made by a client.
026 */
027@SuppressWarnings("PMD.DataClass")
028public class ClientConnected extends Connected<OpenTcpConnection> {
029
030    /**
031     * Creates a new instance.
032     *
033     * @param openEvent the open event
034     * @param localAddress the local address
035     * @param remoteAddress the remote address
036     * (in case of a TLS connection)
037     */
038    public ClientConnected(OpenTcpConnection openEvent,
039            SocketAddress localAddress, SocketAddress remoteAddress) {
040        super(localAddress, remoteAddress);
041        setResult(openEvent);
042    }
043
044    /**
045     * Returns the event that caused this connection to be established.
046     * 
047     * @return the event
048     */
049    public OpenTcpConnection openEvent() {
050        return currentResults().get(0);
051    }
052}