nintaco.api

Interface AccessPointListener

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AccessPointListener

The listener interface for access point events. The class that is interested in processing access point events implements this interface and the object created with that class is registered with one of the API.addAccessPointListener() methods.

An access point is a specified CPU Memory read or write, or instruction execution point. When an access point is defined, it is associated with an implementation of this listener, providing a callback when the access point is hit.

The CPU Memory read and write methods of API do not trigger access points. Consequentially, they can be called within this listener without causing recursive loops.

Method Summary

Modifier and Type	Method and Description
int	accessPointHit(int accessPointType, int address, int value) Invoked when an access point is encountered.

Method Detail

accessPointHit

int accessPointHit(int accessPointType,
                   int address,
                   int value)

Invoked when an access point is encountered.

Parameters:

accessPointType - One of the AccessPointType constants, indicating the type of access point that was encountered.

address - The CPU Memory address where the access point was encountered.

value - PostRead, PreWrite and PostWrite provide the read value, the value to be written and the written value respectively. The remaining access point types use -1 to indicate no value.

Returns:

PreRead, PostRead and PreWrite handlers can optionally return a substitute byte value in place of the value to be read, the read value and the value to be written respectively, in the lower 8 bits. Or, they can return -1 to indicate no modified behavior. The returned value of the remaining access point types is ignored.

See Also:

AccessPointType