org.rocstreaming.roctoolkit

Class RocContext

java.lang.Object

org.rocstreaming.roctoolkit.RocContext

All Implemented Interfaces:

java.lang.AutoCloseable

public class RocContext
extends java.lang.Object

Shared context.

Context contains memory pools and network worker threads, shared among objects attached to the context. It is allowed both to create a separate context for every object, or to create a single context shared between multiple objects.

Lifecycle

A context is created using RocContext() or RocContext(RocContextConfig) and destroyed using close(). RocContext class implements AutoCloseable so if it is used in a try-with-resources statement the object is closed automatically at the end of the statement. Objects can be attached and detached to an opened context at any moment from any thread. However, the user should ensure that the context is not closed until there are no objects attached to the context.

See Also:

RocSender, RocReceiver

Constructor Summary

Constructors

Constructor and Description
RocContext() Open a new context.
RocContext(RocContextConfig config) Open a new context.

Method Summary

Modifier and Type	Method and Description
void	close() Close the native object and unregister it from the NativeObjectCleaner.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RocContext

public RocContext()
           throws java.lang.IllegalArgumentException,
                  java.lang.Exception

Open a new context.

Allocates and initializes a new context. May start some background threads.

Throws:

java.lang.IllegalArgumentException - if the arguments are invalid.

java.lang.Exception - if there are not enough resources.

RocContext

public RocContext(RocContextConfig config)
           throws java.lang.IllegalArgumentException,
                  java.lang.Exception

Open a new context.

Allocates and initializes a new context. May start some background threads.

Parameters:

config - should point to an initialized config.

Throws:

java.lang.IllegalArgumentException - if the arguments are invalid.

java.lang.Exception - if there are not enough resources.

Method Detail

close

public void close()
           throws java.lang.Exception

Close the native object and unregister it from the NativeObjectCleaner.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception - if the underlying roc native object cannot be closed.