IComponentState interface
Contents
- Introduction to the Library
- Basic support package (com.kryptel.bslx)
- Kryptel API Commons package (com.kryptel)
- ApiHelpers class
- Constants class
- IComponentCapabilities interface
- IComponentState interface
- ICompressionLevelCallback interface
- IDataSink interface
- IKryptelComponent interface
- INotification interface
- IProgressCallback interface
- IReplaceCallback interface
- Loader class
- Message class
- Progress class
- ProgressCallback class
- Cipher package (com.kryptel.cipher)
- Compressor package (com.kryptel.compressor)
- Exceptions package (com.kryptel.exceptions)
- Hash function package (com.kryptel.hash_function)
- MAC function package (com.kryptel.mac)
- Key-related functions (com.kryptel.key)
- Silver Key engine (com.kryptel.silver_key)
- Kryptel encrypted storage (com.kryptel.storage)
Declaration
package com.kryptel;
public interface IComponentState {
public enum ComponentState { ComponentIdle, ComponentBusy }
ComponentState GetState() throws Exception;
void Reset() throws Exception;
IKryptelComponent Clone() throws Exception;
}
Description
This interface is exported by every component along with IKryptelComponent interface.
See also Components to learn more about component structure and usage.
Clone
IKryptelComponent Clone() throws Exception;
Creates another instance of the component initialized with the same parameters (including such parameters as key and initialization vector).
The function returns IKryptelComponent of the new copy or null if the component does not support cloning.
GetState
ComponentState GetState() throws Exception;
Returns the state of the component (ComponentIdle or ComponentBusy).
Reset
void Reset() throws Exception;
Resets the component to the ComponentIdle state. This function should be called after abnormal processing termination, for instance, it should be a part of error/exception handling.