TRODiscoveryClient
Overview
This class implements the client side of the local network server discovery infrastructure in Remoting SDK.
Location
- Unit: uRODiscovery.pas
- Ancestry: TComponent | TROComponent | TROCustomDiscoveryClient | TRODiscoveryClient
constructor Create override (declared in TROCustomDiscoveryClient)
Standard component constructor
constructor Create(aOwner: TComponent)
Parameters:
- aOwner: Owner
Assign override (declared in TROCustomDiscoveryClient)
Copies the contents of another, similar object.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Instance whose properties will be copied
Channel
Channel which will be used to locate servers.
property Channel: TROBroadcastChannel read write
CheckProperties (declared in TROCustomDiscoveryClient)
Validates the discovery client properties.
procedure CheckProperties
Message
Defines the message format to use to talk to the servers.
property Message: TROMessage read write
Notification protected override (declared in TROCustomDiscoveryClient)
Forwards notification messages to all owned components.
procedure Notification(aComponent: TComponent; Operation: TOperation)
Parameters:
- aComponent: component
- Operation: operation
OnDiscoveryException
Fires if any exception was raised while probing for servers.If an event handler is assigned, exceptions will not be re-raised after the event handler has executed.
property OnDiscoveryException: TRODiscoveryException read write
OnNewServersFound
Fires whenever the ServerList has been updated; whether new servers have been found or old servers have been removed.
property OnNewServersFound: TNotifyEvent read write
OnNewServiceFound
Fires whenever a new server responded to the broadcast.The event gets passed the server name, as well as any user-specific TRODiscoveryOptions that might have been returned from the server. The event gets fired before the newly found server is added to the ServerList.
property OnNewServiceFound: TRODiscoveryNewServiceFoundEvent read write
RefreshServerList (declared in TROCustomDiscoveryClient)
Performs a network broadcast to find new servers. If needed, a user-defined TRODiscoveryOptions descendant might be passed to the server to provide additional details or requirements for the desired service.
As responses from servers come in, the ServerList property is filled and the OnNewServiceFound and OnNewServersFound events are fired.
procedure RefreshServerList(aDiscoveryOptions: TRODiscoveryOptions)
Parameters:
- aDiscoveryOptions: options
ROFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure ROFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
RORemoveFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure RORemoveFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
SendRemoveNotification protected (declared in TROComponent)
Forwards notification messages to all owned components.
procedure SendRemoveNotification(aComponent: TComponent)
Parameters:
- aComponent: component
ServerList
Contains the list of servers that have been found to provide the requested Service. Call the RefreshServerList to (re)query the network and find new servers.
property ServerList: TStrings read
ServiceName
Specifies the Service name to look for on the local network.
property ServiceName: string read write
Channel
Channel which will be used to locate servers.
property Channel: TROBroadcastChannel read write
Message
Defines the message format to use to talk to the servers.
property Message: TROMessage read write
OnDiscoveryException
Fires if any exception was raised while probing for servers.If an event handler is assigned, exceptions will not be re-raised after the event handler has executed.
property OnDiscoveryException: TRODiscoveryException read write
OnNewServersFound
Fires whenever the ServerList has been updated; whether new servers have been found or old servers have been removed.
property OnNewServersFound: TNotifyEvent read write
OnNewServiceFound
Fires whenever a new server responded to the broadcast.The event gets passed the server name, as well as any user-specific TRODiscoveryOptions that might have been returned from the server. The event gets fired before the newly found server is added to the ServerList.
property OnNewServiceFound: TRODiscoveryNewServiceFoundEvent read write
ServerList
Contains the list of servers that have been found to provide the requested Service. Call the RefreshServerList to (re)query the network and find new servers.
property ServerList: TStrings read
ServiceName
Specifies the Service name to look for on the local network.
property ServiceName: string read write
constructor Create override (declared in TROCustomDiscoveryClient)
Standard component constructor
constructor Create(aOwner: TComponent)
Parameters:
- aOwner: Owner
Assign override (declared in TROCustomDiscoveryClient)
Copies the contents of another, similar object.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Instance whose properties will be copied
CheckProperties (declared in TROCustomDiscoveryClient)
Validates the discovery client properties.
procedure CheckProperties
Notification protected override (declared in TROCustomDiscoveryClient)
Forwards notification messages to all owned components.
procedure Notification(aComponent: TComponent; Operation: TOperation)
Parameters:
- aComponent: component
- Operation: operation
RefreshServerList (declared in TROCustomDiscoveryClient)
Performs a network broadcast to find new servers. If needed, a user-defined TRODiscoveryOptions descendant might be passed to the server to provide additional details or requirements for the desired service.
As responses from servers come in, the ServerList property is filled and the OnNewServiceFound and OnNewServersFound events are fired.
procedure RefreshServerList(aDiscoveryOptions: TRODiscoveryOptions)
Parameters:
- aDiscoveryOptions: options
ROFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure ROFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
RORemoveFreeNotification (declared in TROComponent)
Forwards notification messages to all owned components.
procedure RORemoveFreeNotification(aComponent: TComponent)
Parameters:
- aComponent: component
SendRemoveNotification protected (declared in TROComponent)
Forwards notification messages to all owned components.
procedure SendRemoveNotification(aComponent: TComponent)
Parameters:
- aComponent: component