EDriver.java

/**
 * This file is part of Erjang - A JVM-based Erlang VM
 *
 * Copyright (c) 2009 by Trifork
 *
 * 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 erjang.driver;

import java.util.concurrent.locks.ReentrantLock;

import erjang.EString;

/**
 * Abstract class for drivers.
 * 
 */
public interface EDriver {

	/* called when open_port/2 is invoked.
	   return value null means failure. */
	EDriverControl start(EString command); 
	
	/* called before unloading the driver -
	   DYNAMIC DRIVERS ONLY */
	void finish();
	
	/* name supplied as command 
	   in open_port XXX ? */
	String driverName();
	
	/** override this to return true if you want driver-level locking */
	boolean useDriverLevelLocking();

	/** get the shared lock for all instances of this driver */
	ReentrantLock getLock();
	
}