Relativity.OutsideIn 2021.2.1 - API Reference

<PackageReference Include="Relativity.OutsideIn" Version="2021.2.1" />

API Differences between 2021.2.1 and 2019.5.0

183 Additions 12 Removals

OILink

public class OILink : ProcessOwner
- public static ILog _RelLogger
- public string ConversionId { get; set; }
- public static void SetLogger(ILog logger)
- public int FIGetFileId(FileInfo finfo, bool DoExtendedFI)
- public int FIGetFileId(BasicIO source, bool DoExtendedFI)
- public int FIGetFileId(string path, bool DoExtendedFI)
- public int FIGetFileId(FileInfo finfo, int FIFlags)
- public int FIGetFileId(BasicIO source, int FIFlags)
- public int FIGetFileId(string path, int FIFlags)
- public bool isAlive()
- public bool isAlive(bool PossibleInterruptError)
- public void SetMetricsDict(Dictionary<string, object> metrics)
- public void UpdateOILinkMetricsData()
public class OILinkMetricsData
- public int InputBytesRead { get; set; }
- public int OutputBytesWritten { get; set; }
public class OILinkMonitor
- public static ILog RelLogger { get; set; }
- public static void beforeProcess(long timeout)
- public static void beforeProcess(long processTimeout, long pulseTimeOut)
- public static bool GetStatus(ref TMIStatus status, ref TimeSpan totalElapsedTime)
- public static void Pulse()
public class OILinkProcessTimeOutException : OILinkTimeOutException
- public OILinkProcessTimeOutException(TimeSpan ts)
- public OILinkProcessTimeOutException(TimeSpan ts, Exception ex)
- protected OILinkProcessTimeOutException(SerializationInfo info, StreamingContext context)
public class OILinkPulseTimeOutException : OILinkTimeOutException
- public OILinkPulseTimeOutException(TimeSpan ts)
- public OILinkPulseTimeOutException(TimeSpan ts, Exception ex)
- protected OILinkPulseTimeOutException(SerializationInfo info, StreamingContext context)
public class OILinkSccErr
- public static OILinkSccErr OILINK_PULSETIMEOUT
public class OILinkTerminatedException : OILinkException
- public OILinkTerminatedException()
- public OILinkTerminatedException(string err)
- public OILinkTerminatedException(string err, Exception ex)
- protected OILinkTerminatedException(SerializationInfo info, StreamingContext context)
public abstract class OILinkTimeOutException : OILinkException
- public OILinkTimeOutException()
- public OILinkTimeOutException(string err)
- public OILinkTimeOutException(string err, Exception ex)
- public TimeSpan TimeElapsedBeforeTimeout
- public OILinkTimeOutException(TimeSpan ts, string err)
- public OILinkTimeOutException(TimeSpan ts, string err, Exception ex)
public class OILogMessage
- public string ConversionId
- public string Filename
- public string FunctionName
- public int LineNumber
- public string Message
- public OILogMessage(string convId, LogMessageInfo logMessageInfo)
- public OILogMessage(string convId, string message, int lineNumber = 0, string callingFilePath = "", string caller = null)
public enum TMIStatus
- OK = 0
- PulseTimedOut = 2
- TimedOut = 1

OutsideIn

public interface Exporter : Document, OptionsCache, IAnnotatable, IDisposable
- Dictionary<string, object> GetExportMetrics()
- int GetExportTimeout()
- int GetIdentifyTimeout()
- int GetPulseTimeout()
- FileFormat Identify(FileInfo fileInfo, FileIdentificationTestChoices IdentificationTests)
- OptionsCache SetPulseTimeout(int millisecondsPulseTimeout)
public class FileFormat
- public static FileFormat FI_CSV_ANSI
- public static FileFormat FI_CSV_UNICODE
- public static FileFormat FI_CSV_UTF8
public enum FileIdentificationTestChoices
- All = 9
- CSV = 8
- Extended = 1
- None = 0
public class OutsideIn
- public static void SetLogger(ILog Logger)
public class OutsideInPulseTimeOutException : OutsideInException
- protected OutsideInPulseTimeOutException(SerializationInfo info, StreamingContext context)
public class OutsideInTimeOutException : OutsideInException
- protected OutsideInTimeOutException(SerializationInfo info, StreamingContext context)

OutsideIn.Options

public class Options : OptionImpl
- public enum OILogLevel
- public class OptIncludeRSMFSummary : Options
- public class OptMaxLogLevel : Options
- public class OptPerformCSVIdentfication : Options
- public static OptIncludeRSMFSummary IncludeRSMFSummary
- public static OptMaxLogLevel MaxLogLevel
- public static OptPerformCSVIdentfication PerformCSVIdentfication
public interface OptionsCache
- bool IncludeRSMFSummary { get; set; }
- OILogLevel MaxLogLevel { get; set; }
- bool PerformCSVIdentfication { get; set; }
- bool GetIncludeRSMFSummary()
- OILogLevel GetMaxLogLevel()
- bool GetPerformCSVIdentfication()
- OptionsCache SetConversionId(string convId)
- OptionsCache SetIncludeRSMFSummary(bool IncludeRSMFSummary)
- OptionsCache SetMaxLogLevel(OILogLevel MaxLogLevel)
- OptionsCache SetPerformCSVIdentfication(bool PerformCSVIdentfication)
public enum SpecialOptionsValue
- FIFlagsOption = 134217728
- PulseTimeoutOption = 268435456

oilinkmessages

public sealed class FIGetFileId : IMessage<FIGetFileId>, IMessage, IEquatable<FIGetFileId>, IDeepCloneable<FIGetFileId>
- public const int ExtFIFieldNumber = 2
- public const int FIFlagsFieldNumber = 2
- public bool ExtFI { get; set; }
- public int FIFlags { get; set; }
public sealed class FIGetFileIdViaPath : IMessage<FIGetFileIdViaPath>, IMessage, IEquatable<FIGetFileIdViaPath>, IDeepCloneable<FIGetFileIdViaPath>
- public const int ExtFIFieldNumber = 2
- public const int FIFlagsFieldNumber = 2
- public bool ExtFI { get; set; }
- public int FIFlags { get; set; }
public sealed class LogMessageInfo : IMessage<LogMessageInfo>, IMessage, IEquatable<LogMessageInfo>, IDeepCloneable<LogMessageInfo>
- public static class Types
- public const int FileNameFieldNumber = 3
- public const int FunctionNameFieldNumber = 4
- public const int LineNumberFieldNumber = 5
- public const int LogMessageFieldNumber = 2
- public const int MsgLogLevelFieldNumber = 1
- public static MessageDescriptor Descriptor { get; }
- public static MessageParser<LogMessageInfo> Parser { get; }
- public string FileName { get; set; }
- public string FunctionName { get; set; }
- public int LineNumber { get; set; }
- public string LogMessage { get; set; }
- public LogLevel MsgLogLevel { get; set; }
- public LogMessageInfo()
- public LogMessageInfo(LogMessageInfo other)
- public int CalculateSize()
- public LogMessageInfo Clone()
- public bool Equals(LogMessageInfo other)
- public void MergeFrom(LogMessageInfo other)
- public void MergeFrom(CodedInputStream input)
- public void WriteTo(CodedOutputStream output)
public sealed class MetricsMessageInfo : IMessage<MetricsMessageInfo>, IMessage, IEquatable<MetricsMessageInfo>, IDeepCloneable<MetricsMessageInfo>
- public static class Types
- public const int BoolDataFieldNumber = 3
- public const int DatatypeFieldNumber = 2
- public const int FloatDataFieldNumber = 7
- public const int IntDataFieldNumber = 5
- public const int KeynameFieldNumber = 1
- public const int StringDataFieldNumber = 6
- public static MessageDescriptor Descriptor { get; }
- public static MessageParser<MetricsMessageInfo> Parser { get; }
- public bool BoolData { get; set; }
- public DataType Datatype { get; set; }
- public float FloatData { get; set; }
- public long IntData { get; set; }
- public string Keyname { get; set; }
- public string StringData { get; set; }
- public MetricsMessageInfo()
- public MetricsMessageInfo(MetricsMessageInfo other)
- public int CalculateSize()
- public MetricsMessageInfo Clone()
- public bool Equals(MetricsMessageInfo other)
- public void MergeFrom(MetricsMessageInfo other)
- public void MergeFrom(CodedInputStream input)
- public void WriteTo(CodedOutputStream output)
public sealed class ProtoFileVersion : IMessage<ProtoFileVersion>, IMessage, IEquatable<ProtoFileVersion>, IDeepCloneable<ProtoFileVersion>
- public static class Types
- public static MessageDescriptor Descriptor { get; }
- public static MessageParser<ProtoFileVersion> Parser { get; }
- public ProtoFileVersion()
- public ProtoFileVersion(ProtoFileVersion other)
- public int CalculateSize()
- public ProtoFileVersion Clone()
- public bool Equals(ProtoFileVersion other)
- public void MergeFrom(ProtoFileVersion other)
- public void MergeFrom(CodedInputStream input)
- public void WriteTo(CodedOutputStream output)
public sealed class ProtoFileVersionInfo : IMessage<ProtoFileVersionInfo>, IMessage, IEquatable<ProtoFileVersionInfo>, IDeepCloneable<ProtoFileVersionInfo>
- public const int MaxToClientMsgsFieldNumber = 2
- public const int MaxToNativeMsgsFieldNumber = 3
- public const int ProtoFileVersionFieldNumber = 1
- public static MessageDescriptor Descriptor { get; }
- public static MessageParser<ProtoFileVersionInfo> Parser { get; }
- public int MaxToClientMsgs { get; set; }
- public int MaxToNativeMsgs { get; set; }
- public int ProtoFileVersion { get; set; }
- public ProtoFileVersionInfo()
- public ProtoFileVersionInfo(ProtoFileVersionInfo other)
- public int CalculateSize()
- public ProtoFileVersionInfo Clone()
- public bool Equals(ProtoFileVersionInfo other)
- public void MergeFrom(ProtoFileVersionInfo other)
- public void MergeFrom(CodedInputStream input)
- public void WriteTo(CodedOutputStream output)
public sealed class PulseMessageInfo : IMessage<PulseMessageInfo>, IMessage, IEquatable<PulseMessageInfo>, IDeepCloneable<PulseMessageInfo>
- public const int NumPulsesCollectedFieldNumber = 1
- public static MessageDescriptor Descriptor { get; }
- public static MessageParser<PulseMessageInfo> Parser { get; }
- public int NumPulsesCollected { get; set; }
- public PulseMessageInfo()
- public PulseMessageInfo(PulseMessageInfo other)
- public int CalculateSize()
- public PulseMessageInfo Clone()
- public bool Equals(PulseMessageInfo other)
- public void MergeFrom(PulseMessageInfo other)
- public void MergeFrom(CodedInputStream input)
- public void WriteTo(CodedOutputStream output)
public sealed class ToClient : IMessage<ToClient>, IMessage, IEquatable<ToClient>, IDeepCloneable<ToClient>
- public const int LogMessageInfoFieldNumber = 26
- public const int MetricsMessageInfoFieldNumber = 28
- public const int ProtoFileVersionInformationFieldNumber = 25
- public const int PulseMessageInfoFieldNumber = 27
- public LogMessageInfo LogMessageInfo { get; set; }
- public MetricsMessageInfo MetricsMessageInfo { get; set; }
- public ProtoFileVersionInfo ProtoFileVersionInformation { get; set; }
- public PulseMessageInfo PulseMessageInfo { get; set; }