com.crankuptheamps.client.ProtocolParser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of amps-client Show documentation

AMPS Java client by 60East Technologies, Inc.

There is a newer version: 5.3.4.0

////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2010-2022 60East Technologies Inc., All Rights Reserved.
//
// This computer software is owned by 60East Technologies Inc. and is
// protected by U.S. copyright laws and other laws and by international
// treaties.  This computer software is furnished by 60East Technologies
// Inc. pursuant to a written license agreement and may be used, copied,
// transmitted, and stored only in accordance with the terms of such
// license agreement and with the inclusion of the above copyright notice.
// This computer software or any other copies thereof may not be provided
// or otherwise made available to any other person.
//
// U.S. Government Restricted Rights.  This computer software: (a) was
// developed at private expense and is in all respects the proprietary
// information of 60East Technologies Inc.; (b) was not developed with
// government funds; (c) is a trade secret of 60East Technologies Inc.
// for all purposes of the Freedom of Information Act; and (d) is a
// commercial item and thus, pursuant to Section 12.212 of the Federal
// Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202,
// Government's use, duplication or disclosure of the computer software
// is subject to the restrictions set forth by 60East Technologies Inc..
//
////////////////////////////////////////////////////////////////////////////

package com.crankuptheamps.client;

import java.nio.ByteBuffer;

import com.crankuptheamps.client.exception.StreamException;

    /**
    * Interface that parses an AMPS wire transport protocol. Classes which implement this interface parse a byte stream
    * using one of the AMPS-supported protocols. 
    */

public interface ProtocolParser
{
    /**
     * Processes a region of a byte buffer into messages of a specific protocol and then invokes the specified message 
     * handler for each message parsed from the bytes. 
     * @param buffer The byte buffer to be processed.
     * @param length The length of the byte buffer.
     * @param listener The message handler invoked for each message. 
     * @throws StreamException Thrown when the buffer contains corrupt data or data that is in an invalid format.
     */
    public void process(ByteBuffer buffer, int length, MessageHandler listener)
    throws StreamException;
}