Uses of Class
com.rbnb.sapi.SAPIException

Packages that use SAPIException

com.rbnb.plugins	Provides the PlugInTemplate class for streamlining PlugIn development.
com.rbnb.sapi	Provides the simple application programming interface (simple API or SAPI) for the RBNB system.

Uses of SAPIException in com.rbnb.plugins

Methods in com.rbnb.plugins that throw SAPIException

protected ChannelMap	PlugInTemplate.createForwardMap(PlugInChannelMap picm) Callback to create a ChannelMap to be used to request data from the server to match an incoming request.
protected ChannelMap	PlugInTemplate.getForwardData(Sink sink, ChannelMap mappedChannels, PlugInChannelMap picm) Callback to make the request to the server for matching data.
Sink	PlugInTemplate.getRequestSink() For sinks where the default request forwarding approach is inappropriate, this method may be used to get a handle to a Sink to make requests.
protected void	PlugInTemplate.processRegistrationRequest(ChannelMap fwdReg, PlugInChannelMap out) Callback to handle requests for dynamic registration.
protected abstract void	PlugInTemplate.processRequest(ChannelMap fwdData, PlugInChannelMap out) Override this callback to perform the plug-in processing.
void	PlugInTemplate.start() Starts the PlugIn in another thread, returning execution to the current thread.

Uses of SAPIException in com.rbnb.sapi

Methods in com.rbnb.sapi that throw SAPIException

int	ChannelMap.Add(String channelName) Adds a channel (or channels, if a wildcard is used) to the acqusition list.
void	ChannelMap.AddFolder(String channelName) Add a folder to this channel map.
void	ChannelMap.AddPlugInOption(String channel, String key, String value) Used in request maps, adds an option to configure a PlugIn's response to this request.
void	Source.ClearCache() Flushes any data currently in the Ring Buffer cache into the disk archive.
Control.Mirror	Control.CreateMirrorIn(String remoteServer, String remoteSource, String localName) Creates a mirror to copy data from a source on the specified server address to the connected server.
Control.Mirror	Control.CreateMirrorOut(String localSource, String remoteServer, String remoteName) Creates a mirror to copy data from a local source to the specified remote server.
ChannelMap	Source.Delete(ChannelMap toDelete) Calls Source.Delete(ChannelMap, ChannelMap) with null for the result parameter.
ChannelMap	Source.Delete(ChannelMap toDelete, ChannelMap result) Deletes the maps specified in toDelete.
ChannelMap	Sink.Fetch(long blockTimeout) Obtains the data and time values for the set of channels added via ChannelMap.Add(java.lang.String) and stores them in a newly created ChannelMap.
PlugInChannelMap	PlugIn.Fetch(long blockTimeout) Queries the server to see if any requests have been made of this PlugIn.
ChannelMap	Sink.Fetch(long blockTimeout, ChannelMap cm) Obtains the data and time values for the set of channels added via ChannelMap.Add(java.lang.String) and stores them in the ChannelMap you provide.
PlugInChannelMap	PlugIn.Fetch(long blockTimeout, PlugInChannelMap picm) Queries the server to see if any requests have been made of this PlugIn.
int	Source.Flush(ChannelMap ch) Sends the pending channels to the server, unsynchronized.
int	Source.Flush(ChannelMap ch, boolean doSynch) Sends the pending channels to the server, optionally waiting for confirmation before returning.
int	PlugIn.Flush(PlugInChannelMap ch) Sends the pending channels to the server, as single-response (non-streaming).
int	PlugIn.Flush(PlugInChannelMap ch, boolean doStream) Deprecated. PlugIns no longer receive streaming requests directly, so it is no longer necessary to call this method with true.
Vector	Control.GetAccessControlList() Obtains a list of access control entries from the connected server.
String[]	Client.GetChannelList() Deprecated. Please use Sink.RequestRegistration( ChannelMap) instead.
String[]	Client.GetChannelList(String matchStr) Deprecated. Please use Sink.RequestRegistration( ChannelMap) instead.
void	Sink.Monitor(ChannelMap cm, int gapControl) Similar to Subscribe, but allows for continuous frames of data without gaps.
void	Client.OpenRBNBConnection() Opens a connection to the server, using default parameters.
void	Client.OpenRBNBConnection(String serverAddress, String clientName) Opens a connection to the server, using some default parameters.
void	Client.OpenRBNBConnection(String serverAddress, String clientName, String userName, String password) Opens a connection to the server.
void	ChannelMap.PutData(int channelIndex, byte[] rawData, int typeID) Adds the data given in rawBytes to the channel identified with the specified channel index.
void	ChannelMap.PutData(int channelIndex, byte[] rawData, int typeID, ChannelMap.ByteOrderEnum byteOrder) Adds the data given in rawBytes to the channel identified with the specified channel index.
void	ChannelMap.PutDataAsByteArray(int channelIndex, byte[] data) Type safe version of PutData().
void	ChannelMap.PutDataAsFloat32(int channelIndex, float[] data) Type safe version of PutData().
void	ChannelMap.PutDataAsFloat64(int channelIndex, double[] data) Type safe version of PutData().
void	ChannelMap.PutDataAsInt16(int channelIndex, short[] data) Type safe version of PutData().
void	ChannelMap.PutDataAsInt32(int channelIndex, int[] data) Type safe version of PutData().
void	ChannelMap.PutDataAsInt64(int channelIndex, long[] data) Type safe version of PutData().
void	ChannelMap.PutDataAsInt8(int channelIndex, byte[] data) Type safe version of PutData().
void	ChannelMap.PutDataAsString(int channelIndex, String data) Type safe version of PutData().
void	ChannelMap.PutDataRef(int destChannel, ChannelMap sourceMap, int sourceChannel) Transfers a reference of the data in the sourceMap to this map.
void	ChannelMap.PutUserInfo(int channelIndex, String data) Specify user information for a given channel.
void	Source.Register(ChannelMap cm) Tells the server which channels this Source will generate.
void	PlugIn.Register(ChannelMap cm) Tells the server which channels this PlugIn answers to.
void	Sink.Request(ChannelMap cm, double start, double duration, String reference) Initiates a request for a specific time slice of data; the data may then be extracted with Fetch().
void	Sink.Request(ChannelMap cm, double start, double duration, String timeRef, boolean fetchByFrame) Deprecated. Support for requests by frame has been removed from the API. Please use Sink.Request(ChannelMap,double,double,String). This method is only here for binary compatibility; calling it throws a SAPIException.
void	Sink.Request(ChannelMap cm, double start, double duration, String timeRef, int repeatCount, double repeatInterval, boolean fetchByFrame) Deprecated. Please use Sink.Request(ChannelMap,double,double, String) instead.
void	Sink.Request(ChannelMap cm, double start, double duration, String reference, RequestOptions ro) Sends the specified RequestOptions object to the server before making the request.
void	Sink.RequestFrame(ChannelMap cm) Makes a request for the next new frame.
void	Sink.RequestRegistration() Sends a request for the current registration map of all channels on the server.
void	Sink.RequestRegistration(ChannelMap requestMap) Sends a request to the server for the current registration map for the channels in the provided ChannelMap.
void	Control.SetAccessControlList(Vector list) Sets the access control list on the server.
void	Client.SetRingBuffer(int cache, String mode, int archive) Allows the cache size, archive mode, and archive size to be specified outside of the constructor.
void	Sink.Subscribe(ChannelMap cm) Makes a subscription for newest data with the server.
void	Sink.Subscribe(ChannelMap channelMap, double startTime, double duration, String timeReference) Starts a continuous feed of data on the specified channels to this sink, for retrieval with Fetch().
void	Sink.Subscribe(ChannelMap cm, String timeReference) Deprecated. Please use Sink.Subscribe(ChannelMap,double,double,String) instead. Subscription from oldest by frames can have problems reading from compressed archives.
void	Sink.Subscribe(ChannelMap channelMap, String timeReference, double duration) Deprecated. Please use Sink.Subscribe(ChannelMap,double,double,String) instead. A start time of zero provides the functionality of this method for "newest" and "oldest" start times.
void	Control.Terminate(String name) Stops the object with the given name.
void	Control.TerminateServer() Stops the server to which this Control is connected.