Package Oracle.OpenSync.OSE

Classes
class	OSEException
class	OSEProgressEventArgs
interface	OSETransport
class	OSESession

Enumerations
enum	OSEErrorCode {   OSEErrorCode.SyncCanceled = -12000, OSEErrorCode.UnexpectedOpcode = -12001, OSEErrorCode.DatabaseNotFound = -12002, OSEErrorCode.UserNotSpecified = -12003,   OSEErrorCode.PasswordNotSpecified = -12004, OSEErrorCode.InvalidDMLType = -12005, OSEErrorCode.InvalidOpcode = -12006, OSEErrorCode.OpcodeLengthOverrun = -12007,   OSEErrorCode.OpcodeLengthUnderrun = -12008, OSEErrorCode.MissingPluginAPI = -12009, OSEErrorCode.InvalidPluginFlags = -12010, OSEErrorCode.PluginException = -12011,   OSEErrorCode.InvalidSyncDirection = -12012, OSEErrorCode.InvalidNumericOption = -12013, OSEErrorCode.InvalidStringOption = -12014, OSEErrorCode.UninitializedUserTransport = -12015,   OSEErrorCode.InvalidTransportType = -12016, OSEErrorCode.PluginIdNotFound = -12017, OSEErrorCode.UnexpectedBlobData = -12018, OSEErrorCode.PublicationNotFound = -12019,   OSEErrorCode.SnapshotNameNotFound = -12020, OSEErrorCode.SnapshotIdNotFound = -12021, OSEErrorCode.TransactionNotFound = -12022, OSEErrorCode.SnapshotIdExists = -12023,   OSEErrorCode.OpcodeOutOfSequence = -12024, OSEErrorCode.InvalidEncryptionVersion = -12025, OSEErrorCode.InvalidSession = -12026, OSEErrorCode.InvalidHandle = -12027,   OSEErrorCode.InternalError = -12028, OSEErrorCode.UnexpectedTermOpcode = -12029, OSEErrorCode.EncryptionIdMismatch = -12030, OSEErrorCode.InvalidUnencryptedData = -12031,   OSEErrorCode.InvalidUncompressedData = -12032, OSEErrorCode.InvalidHttpURL = -12033, OSEErrorCode.InvalidEncryptionType = -12034, OSEErrorCode.HttpResponseError = -12035,   OSEErrorCode.ConfigLoadError = -12036, OSEErrorCode.ConfigSaveError = -12037, OSEErrorCode.ServerError = -12038, OSEErrorCode.InternalErrorWithCause = -12039,   OSEErrorCode.MissingDefaultDatabase = -12040, OSEErrorCode.HttpTransportError = -12041, OSEErrorCode.UserTransportError = -12042, OSEErrorCode.PublicationIdNotFound = -12043,   OSEErrorCode.PluginLibraryNotFound = -12044, OSEErrorCode.FeatureNotSupported = -12045, OSEErrorCode.InvalidBuffer = -12046, OSEErrorCode.InvalidDataPriority = -12047,   OSEErrorCode.ResumeSendError = -12048, OSEErrorCode.ResumeReceiveError = -12049 }
enum	SyncDirection { SyncDirection.SendReceive, SyncDirection.Send, SyncDirection.Receive }
enum	TransportDirection { TransportDirection.SendReceive, TransportDirection.Send, TransportDirection.Receive }
enum	EncryptionType { EncryptionType.AES, EncryptionType.SSL, EncryptionType.None }
enum	TransportType { TransportType.Http, TransportType.User, TransportType.File }
enum	DataPriority { DataPriority.High = 0, DataPriority.Normal = 1, Lowest = Normal }
enum	SyncProgressStage {   SyncProgressStage.Idle, SyncProgressStage.Prepare, SyncProgressStage.Send, SyncProgressStage.Receive,   SyncProgressStage.Process }

Functions
delegate void	OSEProgressHandler (object sender, OSEProgressEventArgs args)

Enumeration Type Documentation

enum Oracle.OpenSync.OSE.DataPriority

Data priority. Currently only two priorities are supported, high and normal.

Enumerator
High	high priority
Normal	normal priority

enum Oracle.OpenSync.OSE.EncryptionType

Encryption type. Indicates how the data is encrypted when transfered over the network.

Enumerator
AES	Encrypt using AES
SSL	Use HTTPS protocol, so the data will go through secure sockets
None	No encryption

enum Oracle.OpenSync.OSE.OSEErrorCode

OSE error codes

Enumerator
SyncCanceled	Sync was canceled from another thread
UnexpectedOpcode	Unexpected opcode received from mobile server
DatabaseNotFound	Could not find given database
UserNotSpecified	Sync user name is missing and the last user was not saved
PasswordNotSpecified	Sync password is missing and was not previously saved
InvalidDMLType	Invalid dml type of a record received from plugin
InvalidOpcode	Invalid opcode received from mobile server
OpcodeLengthOverrun	Not enough bytes left in a given opcode to process
OpcodeLengthUnderrun	Opcode has some extra bytes remaining
MissingPluginAPI	Plugin API is missing in the plugin library
InvalidPluginFlags	Plugin has some invalid flags set
PluginException	Error occurred in plugin
InvalidSyncDirection	Invalid sync direction specified This is internal error in the .Net wrapper.
InvalidNumericOption	Invalid numeric option specified This is internal error in the .Net wrapper.
InvalidStringOption	Invalid string option specified This is internal error in the .Net wrapper.
UninitializedUserTransport	User transport is not set while transport type is set to User
InvalidTransportType	Invalid transport type specified This is internal error in the .Net wrapper.
PluginIdNotFound	Could not find plugin with given id
UnexpectedBlobData	Blob data received for plugin that doesn't support blobs
PublicationNotFound	Could not find publication with given name
SnapshotNameNotFound	Could not find snapshot with given name
SnapshotIdNotFound	Could not find snapshot with given id
TransactionNotFound	Could not find transaction with given id
SnapshotIdExists	Snapshot with given id already exists
OpcodeOutOfSequence	Received opcode out of sequence
InvalidEncryptionVersion	Invalid encryption transport version specified
InvalidSession	Session is invalid or closed
InvalidHandle	Invalid handle is provided This is internal error in the .Net wrapper.
InternalError	Internal error has occured
UnexpectedTermOpcode	Received unexpected termination opcode from mobile server
EncryptionIdMismatch	Sent encryption id does not match received encryption id
InvalidUnencryptedData	Received erroneous unencrypted data from mobile server
InvalidUncompressedData	Received erroneous uncompressed data from mobile server
InvalidHttpURL	Invalid Http URL specified
InvalidEncryptionType	Invalid encryption type specified This is internal error in the .Net wrapper.
HttpResponseError	Received unsuccessful http response
ConfigLoadError	Failed to load sync meta information
ConfigSaveError	Failed to save sync meta information
ServerError	Error was received from mobile server
InternalErrorWithCause	Internal error has occured, see inner exception
MissingDefaultDatabase	Missing default database needed to create a given snapshot
HttpTransportError	Http transport error has occured
UserTransportError	User transport error has occured
PublicationIdNotFound	Could not find publication with given id
PluginLibraryNotFound	Failed to load plugin library
FeatureNotSupported	Feature is not supported
InvalidBuffer	Invalid buffer specified This is internal error in the .Net wrapper.
InvalidDataPriority	Invalid priority specified This is internal error in the .Net wrapper.
ResumeSendError	Resume transport failure in sending data
ResumeReceiveError	Resume transport failure in receiving data

enum Oracle.OpenSync.OSE.SyncDirection

Sync direction

Enumerator
SendReceive	Bidirectional sync, this is the default
Send	Data is only sent, but not received
Receive	Data is only received, but not sent

enum Oracle.OpenSync.OSE.SyncProgressStage

Sync stages used by user-defined progress callback

Enumerator
Idle	No sync happening
Prepare	Preparing data into temporary file. Only used if OSESession.UseFiles is true. See Also OSESession.UseFiles
Send	Sending data to mobile server
Receive	Receiving data from mobile server
Process	Processing data from temporary file. Only used if OSESession.UseFiles is true. See Also OSESession.UseFiles

enum Oracle.OpenSync.OSE.TransportDirection

Transport direction

Enumerator
SendReceive	Connected sync, this is the default. Note that this can be with either bidirectional or unidirectional sync. For instance, if sync direction is set to Send, it will indicate send-only sync over connected transport (data is sent and acknowledgement is received).
Send	Disconnected sync, send-only. Data is sent without acknowledgement. This can only be used with file-based sync.
Receive	Disconnected sync, receive-only. This can only be used with file-based sync.

enum Oracle.OpenSync.OSE.TransportType

Sync transport type. Transport type designates the protocol used to transfer data to/from mobile server.

Enumerator
Http	Data is transfered using HTTP protocol
User	Data is transfered by the custom transport provided by the application. See Also OSETransport
File	Data is transfered manually using files (file-based sync)

Function Documentation

delegate void Oracle.OpenSync.OSE.OSEProgressHandler	(	object	sender,
		OSEProgressEventArgs	args
	)

Sync progress callback delegate. Usually used to track progress of sync operation and display it in the UI.

Parameters

sender	sender of the event, set to OSESession object to which the handler is attached
args	progress event arguments encapsulating progress stage and value