Platform Symphony .NET API Reference - Version 5.1
Connect Method (clusterURL, applicationName, securityCallback)
NamespacesPlatform.Symphony.SoamSoamFactoryConnect(String, String, ConnectionSecurityCallback)
Creates a connection to the specified Symphony application.
Declaration Syntax
C#
public static Connection Connect(
	string clusterURL,
	string applicationName,
	ConnectionSecurityCallback securityCallback
)
Parameters
clusterURL (String)
A Cluster Specific URL specifying how to connect to the cluster.
applicationName (String)
The name of the application.
securityCallback (ConnectionSecurityCallback)
The security callback to be used for authentication. Ensure the callback exists for the lifetime of the connection.
Return Value
The created Connection.
Remarks
Once this connection is acquired you may proceed to interact with the application.

This overload of the connect call accepts a Cluster Specific URL which will allow the client to connect to different clusters. Cluster Specific URLs must take the following form:

  • file://filename

    e.g. file://c:\Symphony\kernel\conf\ego.conf

    The filename specified must be a valid "ego.conf" file containing all the parameters required to connect to a cluster. If the filename is left blank the default "ego.conf" file will be loaded.

    Limitation: The security plugin (EGO_SEC_PLUGIN) is taken from the ego.conf file that is located in the client host's $EGO_CONFDIR directory for UNIX hosts or the %EGO_CONFDIR% directory for Windows hosts. For a Symphony DE installation that is connecting to a grid, $EGO_CONFIR is $SOAM_HOME/conf on UNIX hosts and %EGO_CONFDIR% is %SOAM_HOME%\conf on Windows hosts. This limitation means that a client machine can only connect to clusters that use the same security plugin that is specified in the EGO_CONFDIR ego.conf file.

    NOTE: If you specify a Cluster Specific URL ego.conf file that is not located in the EGO_CONFDIR directory, you must ensure that the specified file contains the same EGO_SEC_PLUGIN as the ego.conf file in EGO_CONFDIR.

  • master_list://host:port [host:port]

    e.g. master_list://host1:7870 host2:7870 host3:7870

    Host port combination represents the explicit master candidate list to be used when contacting the cluster. The vemkd port is required. NOTE : This form of specifying a Cluster Specific URL is very limited. For customization of further values, e.g. communication timeouts and security options the "file://" form must be used. If the developer chooses to use the "master_list://" form then all additional attributes and settings will be set to the defaults.

Assembly: Platform.Symphony.Soam.Net (Module: Platform.Symphony.Soam.Net) Version: 5.1.0.0