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.io.events;
020
021import org.jgrapes.core.Event;
022
023/**
024 * This event causes the initiator of an I/O channel to shutdown the
025 * channel. After terminating any outstanding actions, the initiator
026 * must eventually send a {@link Closed} event on the I/O channel.
027 * 
028 * The {@link Closed} need not be generated as a direct response to
029 * the {@link Close} event. If the initiator is a server and the
030 * network protocol supports this, the server may first send a close
031 * message to the client and fire the {@link Closed} event when the
032 * confirmation is received from the client. 
033 */
034public class Close extends Event<Void> {
035
036}