org.neo4j.bolt.v1.packstream.PackInput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-bolt Show documentation
Show all versions of neo4j-bolt Show documentation
The core of Neo4j Bolt Protocol, this contains the state machine for Bolt sessions.
/*
* Copyright (c) 2002-2018 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
package org.neo4j.bolt.v1.packstream;
import java.io.IOException;
/**
* This is what {@link PackStream} uses to ingest data, implement this on top of any data source of your choice to
* deserialize the stream with {@link PackStream}.
*/
public interface PackInput
{
/** Consume one byte */
byte readByte() throws IOException;
/** Consume a 2-byte signed integer */
short readShort() throws IOException;
/** Consume a 4-byte signed integer */
int readInt() throws IOException;
/** Consume an 8-byte signed integer */
long readLong() throws IOException;
/** Consume an 8-byte IEEE 754 "double format" floating-point number */
double readDouble() throws IOException;
/** Consume a specified number of bytes */
PackInput readBytes( byte[] into, int offset, int toRead ) throws IOException;
/** Get the next byte without forwarding the internal pointer */
byte peekByte() throws IOException;
}