Class TTAPIOptions
Inheritance
System.Object
TTAPIOptions
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Assembly: tt-net-api.dll
Syntax
public class TTAPIOptions
Constructors
TTAPIOptions(ServiceEnvironment, String, Int32)
Declaration
public TTAPIOptions(ServiceEnvironment environment, string appSecretKey, int timeout)
Parameters
Type |
Name |
Description |
ServiceEnvironment |
environment |
|
System.String |
appSecretKey |
|
System.Int32 |
timeout |
|
TTAPIOptions(TTAPIOptions.SDKMode, ServiceEnvironment, String, Int32)
Declaration
public TTAPIOptions(TTAPIOptions.SDKMode mode, ServiceEnvironment environment, string appSecretKey, int timeout)
Parameters
Properties
AlgoUserDisconnectAction
Declaration
public UserDisconnectAction AlgoUserDisconnectAction { get; set; }
Property Value
AppKey
Declaration
public string AppKey { get; }
Property Value
Type |
Description |
System.String |
|
AppSecretKey
Declaration
public string AppSecretKey { get; }
Property Value
Type |
Description |
System.String |
|
AutospreaderUserDisconnectAction
Declaration
public UserDisconnectAction AutospreaderUserDisconnectAction { get; set; }
Property Value
Description
Declaration
public string Description { get; }
Property Value
Type |
Description |
System.String |
|
DisplayInFlow
Declaration
public bool DisplayInFlow { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableAccountFiltering
Advanced option to indicate the application wants to control the accounts that are
subscribed to orders, fills and positions. If this is set to true, the application will need to
subscribe to the desired accounts via the StartAccounts method on the TTNetAPI instance. As
account's order books are downlaoded and synchronized, the application will AccountSynced events.
Accounts can be subscribed to at anytime during the run of the application but they can not
be unsubscribed. Default is false and all the user's accounts are subscribed.
Declaration
public bool EnableAccountFiltering { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnabledServerSideSynthetics
Enable to use of synthetic orders when running is server side mode. Default is false.
Declaration
public bool EnabledServerSideSynthetics { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableEstimatedPositionInQueue
Declaration
public bool EnableEstimatedPositionInQueue { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableEstimatedPostionInQueue
Declaration
[Obsolete("EnableEstimatedPostionInQueue will be removed in a future release. Please use EnableEstimatedPositionInQueue instead. ")]
public bool EnableEstimatedPostionInQueue { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableFillFeeds
Declaration
public bool EnableFillFeeds { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableOptions
Declaration
public bool EnableOptions { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableOptionsLogging
Declaration
public bool EnableOptionsLogging { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnableOrderExecution
Declaration
public bool EnableOrderExecution { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnablePositions
Declaration
public bool EnablePositions { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
EnablePriceLogging
Declaration
public bool EnablePriceLogging { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Environment
Declaration
public ServiceEnvironment Environment { get; }
Property Value
InstrumentCacheFolder
Declaration
public string InstrumentCacheFolder { get; set; }
Property Value
Type |
Description |
System.String |
|
LogDaysToKeep
Number of days to keep the log files. Must be greater than 0 and less than 365. Default is 10.
Declaration
public uint LogDaysToKeep { get; set; }
Property Value
Type |
Description |
System.UInt32 |
|
LogDebugMessages
Declaration
public bool LogDebugMessages { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
LogFileFolder
Declaration
public string LogFileFolder { get; set; }
Property Value
Type |
Description |
System.String |
|
LoginAttempts
Declaration
public uint LoginAttempts { get; }
Property Value
Type |
Description |
System.UInt32 |
|
LogToConsole
Declaration
public bool LogToConsole { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
MockTradingSessionEnabled
Indicates whether to run in mock trading session mode. Valid only in client side mode.
Default is false.
Declaration
public bool MockTradingSessionEnabled { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Mode
Declaration
public TTAPIOptions.SDKMode Mode { get; }
Property Value
OrderTimeoutSeconds
Number of seconds to wait for an order response message before timing out. Be aware
changing this value could result in delayed notification of possibly lost orders.
Default is 30.
Declaration
public uint OrderTimeoutSeconds { get; set; }
Property Value
Type |
Description |
System.UInt32 |
|
Applicable to Server Side SDK, this property will fail the SDK initialization process if
the price config file is not pointing to uncoalesced price feeds. False by default so no check
is performed. Enable if you NEVER want to run with coalesced prices.
Declaration
public bool PerformPriceConfigCheck { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
PriceWaitMs
Applicable to Server Side SDK, this property will configure the wait time wihen spinning is
not enabled for prices.
Declaration
public ushort PriceWaitMs { get; set; }
Property Value
Type |
Description |
System.UInt16 |
|
PrimaryCurrency
Declaration
public CurrencyCode PrimaryCurrency { get; set; }
Property Value
ProfitLossCalculationType
Declaration
public ProfitLossCalculationType ProfitLossCalculationType { get; set; }
Property Value
ProxyUri
Declaration
public Uri ProxyUri { get; set; }
Property Value
Type |
Description |
System.Uri |
|
ResourceTimeoutInMilliseconds
Declaration
public int ResourceTimeoutInMilliseconds { get; }
Property Value
Type |
Description |
System.Int32 |
|
SDKInstanceId
Declaration
public ulong SDKInstanceId { get; set; }
Property Value
Type |
Description |
System.UInt64 |
|
ServerInstanceId
Declaration
[Obsolete("ServerInstanceId no longer needs to be specified.", false)]
public string ServerInstanceId { get; set; }
Property Value
Type |
Description |
System.String |
|
ServerPriceDelivery
Declaration
[Obsolete("ServerPriceDelivery is EXPERIMENTAL. Please do not use unless discussed w/TT and the ramifications of its use are understood.")]
public TTAPIOptions.PriceDelivery ServerPriceDelivery { get; set; }
Property Value
ServerPriceThreads
Applicable to Server Side SDK, this property will configure the number of threads on which
to process price updates.
Declaration
public byte ServerPriceThreads { get; set; }
Property Value
Type |
Description |
System.Byte |
|
SpinPriceThread
Applicable to Server Side SDK, this property will configure the price receiving thread to spin.
Set to true for the best price performance. If serveral SDK apps will be running simultaneously and you
do not want to consume a core for each app, set to false. Default is true.
Declaration
public bool SpinPriceThread { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
SpinPriceThreadCore
Applicable to Server Side SDK, this property will configure the core on which the price receiving
will spin if spinning is enabled. Set to -1 is not spinning. Default is 1.
Declaration
public int SpinPriceThreadCore { get; set; }
Property Value
Type |
Description |
System.Int32 |
|
UseClassicPrices
Declaration
public bool UseClassicPrices { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
UseDecimalPrices
Declaration
public bool UseDecimalPrices { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
UseIndicativeSettleForPnL
Declaration
public bool UseIndicativeSettleForPnL { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Methods
ToString()
Declaration
public override string ToString()
Returns
Type |
Description |
System.String |
|
Overrides
System.Object.ToString()