server-cluster-procs.tcl

Provides methods for communicating between load-balanced servers.

Location:
packages/acs-tcl/tcl/server-cluster-procs.tcl
Created:
7 Mar 2000
Author:
Jon Salz
CVS Identification:
$Id: server-cluster-procs.tcl,v 1.10.2.7 2023/02/07 17:50:32 gustafn Exp $

Procedures in this file

Detailed information

ad_canonical_server_p (private)

 ad_canonical_server_p

Returns true if this is the primary (called historically "canonical") server, false otherwise. This function is e.g. used to determine, whether scheduled procedures are run on the current node.

Returns:
boolean value

Partial Call Graph (max 5 caller/called nodes):
%3 test_ad_schedule_proc ad_schedule_proc (test acs-tcl) ad_canonical_server_p ad_canonical_server_p test_ad_schedule_proc->ad_canonical_server_p ad_schedule_proc ad_schedule_proc (public) ad_schedule_proc->ad_canonical_server_p

Testcases:
ad_schedule_proc

server_cluster_all_hosts (public)

 server_cluster_all_hosts

Returns a list of all hosts in the server cluster, possibly including the current host.

Partial Call Graph (max 5 caller/called nodes):
%3 packages/acs-admin/www/cluster.tcl packages/acs-admin/ www/cluster.tcl server_cluster_all_hosts server_cluster_all_hosts packages/acs-admin/www/cluster.tcl->server_cluster_all_hosts parameter::get parameter::get (public) server_cluster_all_hosts->parameter::get server_cluster_enabled_p server_cluster_enabled_p (public) server_cluster_all_hosts->server_cluster_enabled_p

Testcases:
No testcase defined.

server_cluster_enabled_p (public)

 server_cluster_enabled_p

Returns true if clustering is enabled.

Partial Call Graph (max 5 caller/called nodes):
%3 test_ad_schedule_proc ad_schedule_proc (test acs-tcl) server_cluster_enabled_p server_cluster_enabled_p test_ad_schedule_proc->server_cluster_enabled_p parameter::get parameter::get (public) server_cluster_enabled_p->parameter::get ad_schedule_proc ad_schedule_proc (public) ad_schedule_proc->server_cluster_enabled_p packages/acs-admin/www/cluster.tcl packages/acs-admin/ www/cluster.tcl packages/acs-admin/www/cluster.tcl->server_cluster_enabled_p packages/acs-tcl/tcl/cluster-init.tcl packages/acs-tcl/ tcl/cluster-init.tcl packages/acs-tcl/tcl/cluster-init.tcl->server_cluster_enabled_p server_cluster_all_hosts server_cluster_all_hosts (public) server_cluster_all_hosts->server_cluster_enabled_p

Testcases:
ad_schedule_proc
[ hide source ] | [ make this the default ]

Content File Source

ad_library {
    Provides methods for communicating between load-balanced servers.

    @cvs-id $Id: server-cluster-procs.tcl,v 1.10.2.7 2023/02/07 17:50:32 gustafn Exp $
    @author Jon Salz <jsalz@mit.edu>
    @creation-date 7 Mar 2000
}

ad_proc server_cluster_enabled_p {} {

    Returns true if clustering is enabled.

} {
    return [parameter::get \
                -package_id $::acs::kernel_id \
                -parameter ClusterEnabledP \
                -default 0]
}

ad_proc server_cluster_all_hosts {} {

    Returns a list of all hosts in the server cluster, possibly
    including the current host.

} {
    if { ![server_cluster_enabled_p] } {
        return {}
    }
    #
    # For now, include the CanonicalServer as well in the all_hosts
    # list, since the eases the configuration. Later, we might want to
    # have a canonical server, which is not a worker node, so it would
    # not need to receive all the cache-flush operations.
    #
    set nodes [lsort -unique [concat \
                                  [parameter::get -package_id $::acs::kernel_id -parameter CanonicalServer] \
                                  [parameter::get -package_id $::acs::kernel_id -parameter ClusterPeerIP] \
                                  [parameter::get -package_id $::acs::kernel_id -parameter DynamicClusterPeers] ]]

    #ns_log notice "server_cluster_all_hosts returns <$nodes>"
    return $nodes
}

ad_proc -private ad_canonical_server_p {} {

    Returns true if this is the primary (called historically
    "canonical") server, false otherwise.

    This function is e.g. used to determine, whether scheduled
    procedures are run on the current node.

    @return boolean value
} {

    return [::acs::cluster current_server_is_canonical_server]
}

# Local variables:
#    mode: tcl
#    tcl-indent-level: 4
#    indent-tabs-mode: nil
# End: