NETLIB II

IS: the Input Stream

Definition

package netscape.net;
import netscape.types.Interval;

public abstract interface IS {
  public abstract int read(byte[] b, Interval timeout) throws Exception;
}

Interface Methods

• There is no creation method. This is an interface. The per-protocol objects that implement the URL Connection interface UC create objects that support this interface.
• read

This method reads data from the stream, into the provided buffer. If the length of the provided array is zero, this method will return zero. This method follows "normal socket semantics" as defined by NSPR 1.0:
• If there is data available, then as much available data as will fit in the array is returned. The call returns immediately, and the return value is the number of bytes read into the array.
• If there is no data available, the call will block until data arrives. As soon as some data is available, the call returns that data in the buffer, even if it does not fill the buffer. The return value is, again, the number of bytes read intothe array.
• If there is no data available and the stream has reached its end, this method returns zero.
The C signature of this method is: jint IS_read(IS *self, jbyte *a, jsize a_length, PRIntervalTime timeout, JMCException **e);

Inherited Methods

C interface

#include "IS.h"

jint IS_read(IS *self, jbyte *a, jsize a_length, PRIntervalTime timeout, JMCException **e);

/* methods inherited from base JMC object interface */
void *IS_getInterface(IS *self, JMCInterfaceID id, JMCException **e);
void IS_addRef(IS *self, JMCException **e);
void IS_release(IS *self, JMCException **e);
jint IS_hashCode(IS *self, JMCException **e);
void *IS_clone(IS *self, JMCException **e);
const char *IS_toString(IS *self, JMCException **e);
void IS_finalize(IS *self, JMCException **e);