CTI32 Engine Class Library

Engine Methods

The methods of the Engine class are listed below. For a complete list of Engine class members, see the Engine Members topic.

Public Static (Shared) Methods

GetMyDllWorkingDirectory Gets The Original Path The Dll Is Running From

Public Instance Methods

ApplyDialingMask Dialing masks are defined in the CTI32Engine.config file. Each port can be assigned a Dialing mask. A dialing mask assists you in adding a 1 for long distance, morphing local numbers, handling special inter-lata dependencies etc. So here is how the dialing mask works: 1) The dialing mask is located and the number of rules for that mask is determined. 2) The logic rolls through each rule starting from the first rule 3) The source and destination is loaded. 4) If the source is empty, that means match that rule no matter what. If the phone number starts with the digits in the source, then the digits in the destination are replaced with those digits.
CancelOutboundCall If you received a handle from one of the GetOutboundHandle methods and then subsequently do NOT call StartOutboundCall() then you must issue a cancel to free up the port to be selected for a future call
ControlledStop Called to begin the controlled Stop state.
DisableFaxResource If the device is failing, you can take it out of service.
EnableFaxResource Put fax resource back in service.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
FreeFaxResourceOverloaded. Returns a fax resource to the pool. Call this once you have finished using the resource.
GetChannelDataForSpecificPort Returns The ChannelData class for a specified Port.
GetFaxResourceOverloaded. Returns a specific fax resource. Use this method For SIP Applications using T38.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetOutboundHandleOverloaded. Select a port available to make an outbound call and return the handle to that port. The algorithm is to first search ports that are designated for outbound only. The algorithm specifies how it searches. If no outbound only ports are available, it will find ports designated as INOUT. The port is locked from other calls until you complete a call or call CancelOutboundCall.
GetOutboundHandleForSpecificPort Get a handle to a specific port that you want to make the outbound call. If you wish to manage your own ports, you can get the handle you need for StartOutboundCall() by calling this method. The port is locked from other calls until you complete a call or call CancelOutboundCall.
GetType (inherited from Object) Gets the Type of the current instance.
IssueStopChannel Issues a stop channel on the specified port's voice resource.
LaunchOutboundCall Select a port available to make an outbound call. Kick the thread responsible for that port, and call the specified DLL and method. The algorithm is to first search ports that are designated for outbound only. It starts with the highest port and works down. If no outbound only ports are available, it will find ports designated as INOUT. It starts with the highest port and works down.
Start Start the CTI32 Engine Service. Pass in the config data. Because starting up can take longer than the service manager will allow, this method spins a thread to do the bulk of the work.
StartOutboundCall If you already have a handle from one of the GetOutboundHandle methods, then kick the thread and make it go. The thread will then call the specified DLL and method.
StartSystem The thead logic spun from the Start() method. This opens all of the ports and gets the system ready for the first call.
Stop Stop the CTI32 Engine service.
StopService Requests The Service To Stop Itself
StopSystem This ic called from the Stop method. Performs the bulk of the shutdown operation such as closing all of the ports.
ToString (inherited from Object) Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

Engine Class | CTI32Engine Namespace