TRODiscoveryClient

Overview

This class implements the client side of the local network server discovery infrastructure in Remoting SDK.

Location

 

constructor Create  override    (declared in TROCustomDiscoveryClient)

Creates a new instance.

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:

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:

OnDiscoveryException    (declared in TROCustomDiscoveryClient)

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
delegate: procedure OnDiscoveryException(aSender: TObject; aException: Exception)

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:

OnNewServersFound    (declared in TROCustomDiscoveryClient)

Fires whenever the ServerList has been updated; whether new servers have been found or old servers have been removed.

property OnNewServersFound: TNotifyEvent read write

OnNewServersFound

Fires whenever the ServerList has been updated; whether new servers have been found or old servers have been removed.

property OnNewServersFound:

OnNewServiceFound    (declared in TROCustomDiscoveryClient)

Fires whenever the ServerList has been updated; whether new servers have been found or old servers have been removed.

property OnNewServiceFound: TRODiscoveryNewServiceFoundEvent read write
delegate: procedure OnNewServiceFound(aSender: TObject; aName: string; aDiscoveryOptions: TRODiscoveryOptions)

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:

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 RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(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:

ServiceName

Specifies the Service name to look for on the local network.

property ServiceName:

 

Channel

Channel which will be used to locate servers.

property Channel:

Message

Defines the message format to use to talk to the servers.

property Message:

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:

OnNewServersFound

Fires whenever the ServerList has been updated; whether new servers have been found or old servers have been removed.

property OnNewServersFound:

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:

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:

ServiceName

Specifies the Service name to look for on the local network.

property ServiceName:

 

constructor Create  override    (declared in TROCustomDiscoveryClient)

Creates a new instance.

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

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 RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

 

OnDiscoveryException    (declared in TROCustomDiscoveryClient)

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
delegate: procedure OnDiscoveryException(aSender: TObject; aException: Exception)

OnNewServersFound    (declared in TROCustomDiscoveryClient)

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    (declared in TROCustomDiscoveryClient)

Fires whenever the ServerList has been updated; whether new servers have been found or old servers have been removed.

property OnNewServiceFound: TRODiscoveryNewServiceFoundEvent read write
delegate: procedure OnNewServiceFound(aSender: TObject; aName: string; aDiscoveryOptions: TRODiscoveryOptions)

See Also