Configuring Transport Components
-
Undocumented
See moreDeclaration
Objective-C
@interface DITAWDLConfig : NSObject <NSCopying, NSMutableCopying> + (instancetype)awdlConfig; @property (nonatomic, readonly, getter=isEnabled) BOOL enabled; - (instancetype)initWithDITAWDLConfig:(DITAWDLConfig *)config; - (instancetype)initWithEnabled:(BOOL)enabled; - (BOOL)isEqualToDITAWDLConfig:(DITAWDLConfig *)config; @end
-
Undocumented
See moreDeclaration
Objective-C
@interface DITMutableAWDLConfig : DITAWDLConfig @property (nonatomic, readwrite, getter=isEnabled) BOOL enabled; @end
-
Undocumented
See moreDeclaration
Objective-C
@interface DITBluetoothLEConfig : NSObject <NSCopying, NSMutableCopying> + (instancetype)bluetoothLEConfig; @property (nonatomic, readonly, getter=isEnabled) BOOL enabled; - (instancetype)initWithDITBluetoothLEConfig:(DITBluetoothLEConfig *)config; - (instancetype)initWithEnabled:(BOOL)enabled; - (BOOL)isEqualToDITBluetoothLEConfig:(DITBluetoothLEConfig *)config; @end
-
Undocumented
See moreDeclaration
Objective-C
@interface DITMutableBluetoothLEConfig : DITBluetoothLEConfig @property (nonatomic, readwrite, getter=isEnabled) BOOL enabled; @end
-
Undocumented
See moreDeclaration
Objective-C
@interface DITHTTPListenConfig : NSObject <NSCopying, NSMutableCopying> + (instancetype)httpListenConfig; @property (nonatomic, readonly, getter=isEnabled) BOOL enabled; /** IP interface to bind to. [::] by default. */ @property (nonatomic, readonly) NSString *interfaceIp; /** Listening port. 80 by default. */ @property (nonatomic, readonly) uint16_t port; /** An absolute path to a directory of static HTTP content that should be served by this device. If nil (default), this feature is disabled. */ @property (nonatomic, readonly, nullable) NSString *staticContentPath; /** If YES (default), peers can connect over websocket to sync with this peer. This feature has security implications and should only be used together with documentation on Ditto's website. */ @property (nonatomic, readonly) BOOL websocketSync; /** An absolute path to the PEM-formatted private key for HTTPS. Must be set together with tlsCertificatePath. If nil, the server runs as unencrypted HTTP. */ @property (nonatomic, readonly, nullable) NSString *tlsKeyPath; /** An absolute path to the PEM-formatted certificate for HTTPS. Must be set together with tlsKeyPath. If nil, the server runs as unencrypted HTTP. */ @property (nonatomic, readonly, nullable) NSString *tlsCertificatePath; /** Enable acting as a provider of Ditto identities. */ @property (nonatomic, readonly, getter=isIdentityProvider) BOOL identityProvider; /** PEM-encoded private key for signing tokens and certificates when acting as an identity provider. */ @property (nonatomic, readonly, nullable) NSString *identityProviderSigningKey; /** PEM-encoded public keys for verifying tokens and certificates when acting as an identity provider. */ @property (nonatomic, readonly, nullable) NSArray<NSString *> *identityProviderVerifyingKeys; /** PEM-encoded private key that should be used to issue certificates for clients in peer-to-peer mode. */ @property (nonatomic, readonly, nullable) NSString *caKey; - (instancetype)initWithDITHTTPListenConfig:(DITHTTPListenConfig *)config; - (instancetype)initWithEnabled:(BOOL)enabled interfaceIp:(NSString *)interfaceIp port:(uint16_t)port staticContentPath:(nullable NSString *)staticContentPath websocketSync:(BOOL)websocketSync tlsKeyPath:(nullable NSString *)tlsKeyPath tlsCertificatePath:(nullable NSString *)tlsCertificatePath isIdentityProvider:(BOOL)isIdentityProvider identityProviderSigningKey:(nullable NSString *)identityProviderSigningKey identityProviderVerifyingKeys:(nullable NSArray<NSString *> *)identityProviderVerifyingKeys caKey:(nullable NSString *)caKey; - (BOOL)isEqualToDITHTTPListenConfig:(DITHTTPListenConfig *)config; @end
-
Undocumented
See moreDeclaration
Objective-C
@interface DITMutableHTTPListenConfig : DITHTTPListenConfig @property (nonatomic, readwrite, getter=isEnabled) BOOL enabled; /** IP interface to bind to. [::] by default. */ @property (nonatomic, readwrite, copy) NSString *interfaceIp; /** Listening port. 80 by default. */ @property (nonatomic, readwrite) uint16_t port; /** An absolute path to a directory of static HTTP content that should be served by this device. If nil (default), this feature is disabled. */ @property (nonatomic, readwrite, copy, nullable) NSString *staticContentPath; /** If YES (default), peers can connect over websocket to sync with this peer. This feature has security implications and should only be used together with documentation on Ditto's website. */ @property (nonatomic, readwrite) BOOL websocketSync; /** An absolute path to the PEM-formatted private key for HTTPS. Must be set together with tlsCertificatePath. If nil (default), the server runs as unencrypted HTTP. */ @property (nonatomic, readwrite, copy, nullable) NSString *tlsKeyPath; /** An absolute path to the PEM-formatted certificate for HTTPS. Must be set together with tlsKeyPath. If nil (default), the server runs as unencrypted HTTP. */ @property (nonatomic, readwrite, copy, nullable) NSString *tlsCertificatePath; /** Enable acting as a provider of Ditto identities. */ @property (nonatomic, readwrite, getter=isIdentityProvider) BOOL identityProvider; /** PEM-encoded private key for signing tokens and certificates when acting as an identity provider. */ @property (nonatomic, readwrite, copy, nullable) NSString *identityProviderSigningKey; /** PEM-encoded public keys for verifying tokens and certificates when acting as an identity provider. */ @property (nonatomic, readwrite, copy, nullable) NSArray<NSString *> *identityProviderVerifyingKeys; /** PEM-encoded private key that should be used to issue certificates for clients in peer-to-peer mode. */ @property (nonatomic, readwrite, copy, nullable) NSString *caKey; @end
-
Undocumented
See moreDeclaration
Objective-C
@interface DITLANConfig : NSObject <NSCopying, NSMutableCopying> + (instancetype)lanConfig; @property (nonatomic, readonly, getter=isEnabled) BOOL enabled; @property (nonatomic, readonly, getter=ismDNSEnabled) BOOL mDNSEnabled; @property (nonatomic, readonly, getter=isMulticastEnabled) BOOL multicastEnabled; - (instancetype)initWithDITLANConfig:(DITLANConfig *)config; - (instancetype)initWithEnabled:(BOOL)enabled mDNSEnabled:(BOOL)mDNSEnabled multicastEnabled:(BOOL)multicastEnabled; - (BOOL)isEqualToDITLANConfig:(DITLANConfig *)config; @end
-
Undocumented
See moreDeclaration
Objective-C
@interface DITMutableLANConfig : DITLANConfig @property (nonatomic, readwrite, getter=isEnabled) BOOL enabled; @property (nonatomic, readwrite, getter=ismDNSEnabled) BOOL mDNSEnabled; @property (nonatomic, readwrite, getter=isMulticastEnabled) BOOL multicastEnabled; @end
-
Undocumented
See moreDeclaration
Objective-C
@interface DITTCPListenConfig : NSObject <NSCopying, NSMutableCopying> + (instancetype)tcpListenConfig; @property (nonatomic, readonly, getter=isEnabled) BOOL enabled; /** IP interface to bind to. [::] by default. */ @property (nonatomic, readonly) NSString *interfaceIp; /** Listening port. 4040 by default. */ @property (nonatomic, readonly) uint16_t port; - (instancetype)initWithDITTCPListenConfig:(DITTCPListenConfig *)config; - (instancetype)initWithEnabled:(BOOL)enabled interfaceIp:(NSString *)interfaceIp port:(uint16_t)port; - (BOOL)isEqualToDITTCPListenConfig:(DITTCPListenConfig *)config; @end
-
Undocumented
See moreDeclaration
Objective-C
@interface DITMutableTCPListenConfig : DITTCPListenConfig @property (nonatomic, readwrite, getter=isEnabled) BOOL enabled; /** IP interface to bind to. [::] by default. */ @property (nonatomic, readwrite, copy) NSString *interfaceIp; /** Listening port. 4040 by default. */ @property (nonatomic, readwrite) uint16_t port; @end
-
Specific servers that Ditto should attempt to connect to.
TCP servers are specified as “host:port”. Websocket URLs take the form “wss://hydra.ditto.live”.
Please refer to the documentation on Ditto’s website for configuring cloud or client/server scenarios.
See moreDeclaration
Objective-C
@interface DITConnect : NSObject <NSCopying, NSMutableCopying>
-
Undocumented
See moreDeclaration
Objective-C
@interface DITMutableConnect : DITConnect
-
Configuration of peer-to-peer transports, which are able to discover and connect to peers on their own.
For more information refer to the documentation for DITTransportConfig.
See moreDeclaration
Objective-C
@interface DITPeerToPeer : NSObject <NSCopying, NSMutableCopying>
-
Undocumented
See moreDeclaration
Objective-C
@interface DITMutablePeerToPeer : DITPeerToPeer
-
Configure this device as a Ditto server. Disabled by default.
This is advanced usage that is not needed in most situations. Please refer to the documentation on Ditto’s website for scenarios and example configurations.
See moreDeclaration
Objective-C
@interface DITListen : NSObject <NSCopying, NSMutableCopying>