/* ###
 * IP: GHIDRA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ghidra.dbg.memory;

import java.util.concurrent.CompletableFuture;

/**
 * The functional interface for reads from a cached memory
 * 
 * @see CachedMemory
 */
public interface MemoryReader {
	/**
	 * Read target memory
	 * 
	 * If cached, any cached regions are removed from the request. If this results in non-contiguous
	 * regions, each generates a new request, forwarded to the wrapped read method.
	 */
	// TODO: Use ByteBuffer instead?
	public CompletableFuture<byte[]> readMemory(long address, int length);
}
