IJCListener

All Known Implementing Classes:

JCListener
```
public interface IJCListener
```
Contract for the JVM-side event raiser used by JCOBridge listeners.
Implementations forward Java interface method calls to the CLR side by invoking one of the raiseEvent overloads. Event identification supports two modes:
- Name-based — pass the event name as a String. Convenient but incurs a name-to-index resolution cost on every call.
- Index-based — pass the numeric index returned by getEventIndex(String), resolved once and cached by the caller. Preferred in high-frequency event paths as it avoids the resolution overhead entirely.
For non-void Java interface methods, the CLR handler must call setReturnData(Object) before returning control to the JVM. The JVM implementation then retrieves the value via getReturnData() and returns it to the original Java caller.
Since:

2.0.0.0

Author:

MASES S.R.L.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Object[]`	`extraData()` Returns the additional arguments associated with the current event.
`int`	`extraDataLength()` Returns the number of additional arguments associated with the current event.
`Object`	`getEventData()` Returns the primary data object associated with the current event.
`int`	`getEventIndex(String eventName)` Returns the numeric index associated with the given event name.
`Object`	`getReturnData()` Returns the return value set by the CLR handler for the current event.
`boolean`	`hasExtraData()` Returns `true` if the current event has additional arguments beyond the primary data object.
`void`	`raiseEvent(int eventIndex)` Raises the event identified by numeric index on the CLR side with no associated data.
`void`	`raiseEvent(int eventIndex, Object e)` Raises the event identified by numeric index on the CLR side, passing a single data object.
`void`	`raiseEvent(int eventIndex, Object e, Object... objects)` Raises the event identified by numeric index on the CLR side, passing a primary data object and additional arguments.
`void`	`raiseEvent(String eventName)` Raises the named event on the CLR side with no associated data.
`void`	`raiseEvent(String eventName, Object e)` Raises the named event on the CLR side, passing a single data object.
`void`	`raiseEvent(String eventName, Object e, Object... objects)` Raises the named event on the CLR side, passing a primary data object and additional arguments.
`void`	`release()` Releases the native resources held by this listener and unregisters it from the JCOBridge runtime.
`void`	`setReturnData(Object retData)` Sets the return value that the CLR handler provides for the current event.

- Method Detail
  - release
```
void release()
```
    Releases the native resources held by this listener and unregisters it from the JCOBridge runtime. Invoked by the CLR counterpart when the managed wrapper is disposed.
  - getEventIndex
```
int getEventIndex(String eventName)
```
    Returns the numeric index associated with the given event name.
    The returned index can be passed to the index-based raiseEvent overloads to avoid name-lookup overhead in high-frequency event paths. The index should be resolved once and cached by the caller.
    
    Parameters:
    
    eventName - the name of the event as registered on the CLR side.
    
    Returns:
    
    the numeric index of the event.
    
    Since:
    
    2.6.9.0
  - raiseEvent
```
void raiseEvent(String eventName)
```
    Raises the named event on the CLR side with no associated data.
    
    Parameters:
    
    eventName - the name of the event to raise.
  - raiseEvent
```
void raiseEvent(int eventIndex)
```
    Raises the event identified by numeric index on the CLR side with no associated data.
    Prefer this overload over the name-based variant in high-frequency paths.
    
    Parameters:
    
    eventIndex - the numeric index of the event to raise, as returned by getEventIndex(String).
    
    Since:
    
    2.6.9.0
  - raiseEvent
```
void raiseEvent(String eventName,
                Object e)
```
    Raises the named event on the CLR side, passing a single data object.
    
    Parameters:
    
    eventName - the name of the event to raise.
    
    e - the data object associated with the event; accessible from the CLR handler via getEventData().
  - raiseEvent
```
void raiseEvent(int eventIndex,
                Object e)
```
    Raises the event identified by numeric index on the CLR side, passing a single data object.
    Prefer this overload over the name-based variant in high-frequency paths.
    
    Parameters:
    
    eventIndex - the numeric index of the event to raise.
    
    e - the data object associated with the event; accessible from the CLR handler via getEventData().
    
    Since:
    
    2.6.9.0
  - raiseEvent
```
void raiseEvent(String eventName,
                Object e,
                Object... objects)
```
    Raises the named event on the CLR side, passing a primary data object and additional arguments.
    
    Parameters:
    
    eventName - the name of the event to raise.
    
    e - the primary data object associated with the event.
    
    objects - additional arguments forwarded to the CLR handler, accessible via extraData().
  - raiseEvent
```
void raiseEvent(int eventIndex,
                Object e,
                Object... objects)
```
    Raises the event identified by numeric index on the CLR side, passing a primary data object and additional arguments.
    Prefer this overload over the name-based variant in high-frequency paths.
    
    Parameters:
    
    eventIndex - the numeric index of the event to raise.
    
    e - the primary data object associated with the event.
    
    objects - additional arguments forwarded to the CLR handler, accessible via extraData().
    
    Since:
    
    2.6.9.0
  - getEventData
```
Object getEventData()
```
    Returns the primary data object associated with the current event. Called by the CLR runtime via JNI to retrieve the argument passed to raiseEvent.
    
    Returns:
    
    the event data object, or null if no data was provided.
  - hasExtraData
```
boolean hasExtraData()
```
    Returns true if the current event has additional arguments beyond the primary data object.
    
    Returns:
    
    true if extra data is available.
    
    Since:
    
    2.4.2.0
  - extraDataLength
```
int extraDataLength()
```
    Returns the number of additional arguments associated with the current event.
    
    Returns:
    
    the length of the extra data array, or 0 if none.
    
    Since:
    
    2.4.2.0
  - extraData
```
Object[] extraData()
```
    Returns the additional arguments associated with the current event. The array order matches the order of the objects vararg passed to raiseEvent.
    
    Returns:
    
    the extra data array, or null if none was provided.
    
    Since:
    
    2.4.2.0
  - getReturnData
```
Object getReturnData()
```
    Returns the return value set by the CLR handler for the current event.
    For non-void Java interface methods, the CLR handler must call setReturnData(Object) before returning control to the JVM. The JVM implementation then calls this method to retrieve the value and return it to the original Java caller.
    
    Returns:
    
    the return value provided by the CLR handler, or null if not set.
    
    Since:
    
    2.4.2.0
  - setReturnData
```
void setReturnData(Object retData)
```
    Sets the return value that the CLR handler provides for the current event.
    Must be called by the CLR runtime before control returns to the JVM for non-void interface methods. The value is then retrieved by the JVM implementation via getReturnData() and returned to the original Java caller.
    
    Parameters:
    
    retData - the value to return to the JVM caller; may be null for reference types if the interface method allows it.
    
    Since:
    
    2.4.2.0

Interface IJCListener

Method Summary

Method Detail

release

getEventIndex

raiseEvent

raiseEvent

raiseEvent

raiseEvent

raiseEvent

raiseEvent

getEventData

hasExtraData

extraDataLength

extraData

getReturnData

setReturnData