Proxy
Overview
The Proxy class is the base class for the Remoting SDK proxy classes that are auto-generated from the RODL file. A Proxy represents a remote object. The auto-generate proxy class will define methods for the remote object it represents and implement these methods to use an appropriate message format and transport channel to communicate method calls to the server and to translate the results.
Developers will not usually implement (nor directly deal with) a proxy class. Instead, call the CoClass's Create method to get back an interface to the methods defined by the service and then call methods on this interface.
Location
- Reference: RemObjects.SDK.dll
- Namespace: RemObjects.SDK
constructor (IMessage, IClientChannel) protected
Creates a new instance of the Proxy class. Can be called only from the descendant class.
constructor(message: IMessage; clientChannel: IClientChannel)
Proxy(IMessage message, IClientChannel clientChannel)
Sub New(message As IMessage, clientChannel As IClientChannel)
Parameters:
- message: Message instance that will be used to perform communications with the server
- clientChannel: Client channel instance that will be used to perform communications with the server
constructor (IMessage, IClientChannel, String) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(message: IMessage; clientChannel: IClientChannel; interfaceName: String)
Proxy(IMessage message, IClientChannel clientChannel, String interfaceName)
Sub New(message As IMessage, clientChannel As IClientChannel, interfaceName As String)
Parameters:
- message: Message instance that will be used to perform communications with the server
- clientChannel: Client channel instance that will be used to perform communications with the server
- interfaceName: Service name. Used to provide server service name other than the default one
constructor (Proxy) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
This constructor is used when it is needed to connect to another service on the same using already configured connection parameters and Client ID. For example this constructor overload can bbe used to simplify instantiation of DataService proxy after successfull authorisation using the LoginService proxy.
Parameters:
- proxy: Proxy instance that will be used as source of all server connection partameters.
constructor (IRemoteService) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(remoteService: IRemoteService)
Proxy(IRemoteService remoteService)
Sub New(remoteService As IRemoteService)
Parameters:
- remoteService: RemoteService instance that will be used to perform communications with the server
constructor (IRemoteService, String) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(remoteService: IRemoteService; interfaceName: String)
Proxy(IRemoteService remoteService, String interfaceName)
Sub New(remoteService As IRemoteService, interfaceName As String)
Parameters:
- remoteService: RemoteService instance that will be used to perform communications with the server
- interfaceName: Service name. Used to provide server service name other than the default one
constructor (Uri) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(uri: Uri)
Proxy(Uri uri)
Sub New(uri As Uri)
Parameters:
- uri: Server Uri
constructor (String) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(url: String)
Proxy(String url)
Sub New(url As String)
Parameters:
- url: Server Uri
ActiveInterfaceName
property ActiveInterfaceName: String read;
String ActiveInterfaceName { get; }
ReadOnly Property ActiveInterfaceName() As String
ClientChannel
property ClientChannel: IClientChannel read;
IClientChannel ClientChannel { get; }
ReadOnly Property ClientChannel() As IClientChannel
CloneMessage
Gets or sets a flag indicating wheter the __GetMessage method should return either a fresh clone of the __Message instance or always the same instance.
property CloneMessage: Boolean read write;
Boolean CloneMessage { get; set; }
Property CloneMessage() As Boolean
InterfaceName
property InterfaceName: String read;
String InterfaceName { get; }
ReadOnly Property InterfaceName() As String
Message
OverridenInterfaceName
Gets or sets the overridden interface name. Setting this property alllows to call descendant services using interface classes generated for their ancestor classes.
property OverridenInterfaceName: String read write;
String OverridenInterfaceName { get; set; }
Property OverridenInterfaceName() As String
ActiveInterfaceName
property ActiveInterfaceName: String read;
String ActiveInterfaceName { get; }
ReadOnly Property ActiveInterfaceName() As String
ClientChannel
property ClientChannel: IClientChannel read;
IClientChannel ClientChannel { get; }
ReadOnly Property ClientChannel() As IClientChannel
CloneMessage
Gets or sets a flag indicating wheter the __GetMessage method should return either a fresh clone of the __Message instance or always the same instance.
property CloneMessage: Boolean read write;
Boolean CloneMessage { get; set; }
Property CloneMessage() As Boolean
InterfaceName
property InterfaceName: String read;
String InterfaceName { get; }
ReadOnly Property InterfaceName() As String
Message
OverridenInterfaceName
Gets or sets the overridden interface name. Setting this property alllows to call descendant services using interface classes generated for their ancestor classes.
property OverridenInterfaceName: String read write;
String OverridenInterfaceName { get; set; }
Property OverridenInterfaceName() As String
constructor (IMessage, IClientChannel) protected
Creates a new instance of the Proxy class. Can be called only from the descendant class.
constructor(message: IMessage; clientChannel: IClientChannel)
Proxy(IMessage message, IClientChannel clientChannel)
Sub New(message As IMessage, clientChannel As IClientChannel)
Parameters:
- message: Message instance that will be used to perform communications with the server
- clientChannel: Client channel instance that will be used to perform communications with the server
constructor (IMessage, IClientChannel, String) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(message: IMessage; clientChannel: IClientChannel; interfaceName: String)
Proxy(IMessage message, IClientChannel clientChannel, String interfaceName)
Sub New(message As IMessage, clientChannel As IClientChannel, interfaceName As String)
Parameters:
- message: Message instance that will be used to perform communications with the server
- clientChannel: Client channel instance that will be used to perform communications with the server
- interfaceName: Service name. Used to provide server service name other than the default one
constructor (Proxy) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
This constructor is used when it is needed to connect to another service on the same using already configured connection parameters and Client ID. For example this constructor overload can bbe used to simplify instantiation of DataService proxy after successfull authorisation using the LoginService proxy.
Parameters:
- proxy: Proxy instance that will be used as source of all server connection partameters.
constructor (IRemoteService) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(remoteService: IRemoteService)
Proxy(IRemoteService remoteService)
Sub New(remoteService As IRemoteService)
Parameters:
- remoteService: RemoteService instance that will be used to perform communications with the server
constructor (IRemoteService, String) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(remoteService: IRemoteService; interfaceName: String)
Proxy(IRemoteService remoteService, String interfaceName)
Sub New(remoteService As IRemoteService, interfaceName As String)
Parameters:
- remoteService: RemoteService instance that will be used to perform communications with the server
- interfaceName: Service name. Used to provide server service name other than the default one
constructor (Uri) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(uri: Uri)
Proxy(Uri uri)
Sub New(uri As Uri)
Parameters:
- uri: Server Uri
constructor (String) protected
Creates a new instance of the AsyncProxy class. Can be called only from the descendant class.
constructor(url: String)
Proxy(String url)
Sub New(url As String)
Parameters:
- url: Server Uri