/*
 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
/**
 * <p>
 *   This package provides the basic functionality to send debug dumps to a
 *   server that is able to process Salver trace events.
 * </p>
 *
 * <p>
 *   Salver is a Web Application Framework for Trace Visualization which
 *   defines an interface for sending trace information via serializable events,
 *   e.g. as JSON text representation. Events are grouped into separate
 *   namespaces to simplify event processing. Listeners can register for a
 *   certain namespace and will receive all relevant events.
 * </p>
 *
 * <p>
 *   In order to process trace events of this package the server needs to listen
 *   for the "graal/graph" namespace.
 * </p>
 *
 * <p>
 *   See {@link com.oracle.graal.salver.SalverOptions SalverOptions} for all
 *   available options.
 * <p>
 *
 * <p>
 *   Basic components of this package:
 *   <ul>
 *     <li>DumpHandler:<br/>
 *       Initialization of the corresponding Dumper in case a given object can
 *       be processed.
 *     </li>
 *     <li>Dumper:<br/>
 *       Processing the object about to be dumped and extract all necessary
 *       information in order to produce a serializable data object.
 *     </li>
 *     <li>Serializer:<br/>
 *       Serializing a given data object, e.g. to a JSON text representation.
 *     </li>
 *     <li>Writer:<br/>
 *       Writing the actual data, e.g. to a WritableByteChannel.
 *     </li>
 *   </ul>
 * </p>
 *
 * <p>
 *   Currently available {@link com.oracle.graal.debug.DebugDumpHandler DebugDumpHandlers}:
 *   <ul>
 *     <li>{@link com.oracle.graal.salver.handler.GraphDumpHandler GraphDumpHandler}:<br>
 *       Dumps {@link com.oracle.graal.graph.Graph Graphs} (extracts almost the
 *       same information as IGV's dump handler).
 *     </li>
 *   </ul>
 * </p>
 */
package com.oracle.graal.salver;