Generated from ./../../../tcl/swig/globus_gram_client.i with ROBODoc v4.99.6 on Mon Jun 05 10:37:52 2006

TABLE OF CONTENTS


[Functions] globus_gram_client/globus_gram_client_attr_destroy

[top][index]

NAME

globus_gram_client_attr_destroy

SYNOPSIS

package require globus_gram_client

globus_gram_client_attr_destroy attr

DESCRIPTION

This command is used to destroy a GRAM client attribute.

RETURN VALUE

On success globus_gram_client_attr_destroy returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gram_client_attr_destroy $attr ] result

BUGS

None

TODO

None


[Functions] globus_gram_client/globus_gram_client_attr_get_credential

[top][index]

NAME

globus_gram_client_attr_get_credential

SYNOPSIS

package require globus_gram_client

globus_gram_client_attr_get_credential attr

DESCRIPTION

This command is used to get the credential associated with an attribute set.

RETURN VALUE

On success globus_gram_client_attr_get_credential returns 0 and credential. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gram_client_attr_get_credential $attr ] result credential

BUGS

None

TODO

None


[Functions] globus_gram_client/globus_gram_client_attr_init

[top][index]

NAME

globus_gram_client_attr_init

SYNOPSIS

package require globus_gram_client

globus_gram_client_attr_init

DESCRIPTION

This command is used to initialize a GRAM client attribute.

RETURN VALUE

On success globus_gram_client_attr_init returns 0 and GRAM client attribute. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gram_client_attr_init ] result attr

BUGS

None

TODO

None


[Functions] globus_gram_client/globus_gram_client_attr_set_credential

[top][index]

NAME

globus_gram_client_attr_set_credential

SYNOPSIS

package require globus_gram_client

globus_gram_client_attr_set_credential attr credential

DESCRIPTION

This command is used to associate a credential with an attribute set.

RETURN VALUE

On success globus_gram_client_attr_set_credential returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gram_client_attr_set_credential $attr $gss_c_no_credential ] result

BUGS

None

TODO

None


[Functions] globus_gram_client/globus_gram_client_callback_allow

[top][index]

NAME

globus_gram_client_callback_allow

SYNOPSIS

package require globus_gram_client

globus_gram_client_callback_allow script

DESCRIPTION

This command is used to create a callback contact.

This command creates a small GRAM server which can handle GRAM state updates from job managers. The contact information for this server is returned and may be used with the globus_gram_client_job_request or globus_gram_client_callback_register command.

PARAMETERS

RETURN VALUE

On success globus_gram_client_callback_allow returns 0 and callback_contact. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] result callback_contact

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_disallow


[Functions] globus_gram_client/globus_gram_client_callback_disallow

[top][index]

NAME

globus_gram_client_callback_disallow

SYNOPSIS

package require globus_gram_client

globus_gram_client_callback_disallow callback_contact

DESCRIPTION

This command is used to disable a callback handler.

This command is to disable the GRAM server created by calling globus_gram_client_callback_allow. This command blocks until all pending job state updates being handled by this server are dispatched.

This command can only be used to disable a callback created in the current process.

PARAMETERS

RETURN VALUE

On success globus_gram_client_callback_disallow returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gram_client_callback_disallow $callback_contact ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow


[Functions] globus_gram_client/globus_gram_client_job_callback_register

[top][index]

NAME

globus_gram_client_job_callback_register

SYNOPSIS

package require globus_gram_client

globus_gram_client_job_callback_register job_contact job_state_mask callback_contact

DESCRIPTION

This command is used to register a callback contact for job state changes.

PARAMETERS

RETURN VALUE

On success globus_gram_client_job_callback_register returns 0, job_status and failure_code. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL NULL ] result job_contact

set job_state_mask [ expr $GLOBUS_GRAM_PROTOCOL_JOB_STATE_FAILED | $GLOBUS_GRAM_PROTOCOL_JOB_STATE_DONE ]

lassign [ globus_gram_client_job_callback_register $job_contact $job_state_mask $callback_contact ] result job_status job_failure_code

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_job_callback_unregister.


[Functions] globus_gram_client/globus_gram_client_job_callback_unregister

[top][index]

NAME

globus_gram_client_job_callback_unregister

SYNOPSIS

package require globus_gram_client

globus_gram_client_job_callback_unregister job_contact callback_contact

DESCRIPTION

This command is used to unregister a callback contact from future job state changes.

PARAMETERS

RETURN VALUE

On success globus_gram_client_job_callback_register returns 0, job_status and failure_code. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL NULL ] result job_contact

lassign [ globus_gram_client_job_callback_unregister $job_contact $callback_contact ] result job_status job_failure_code

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_job_callback_register.


[Functions] globus_gram_client/globus_gram_client_job_cancel

[top][index]

NAME

globus_gram_client_job_cancel

SYNOPSIS

package require globus_gram_client

globus_gram_client_job_cancel job_contact

DESCRIPTION

This command is used to cancel a GRAM-managed job.

Removes a PENDING job request, or kills all processes associated with an ACTIVE job, releasing any associated resources

PARAMETERS

RETURN VALUE

On success globus_gram_client_job_cancel returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL $callback_contact ] result job_contact

lassign [ globus_gram_client_job_cancel $job_contact ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_register_job_cancel.


[Functions] globus_gram_client/globus_gram_client_job_contact_free

[top][index]

NAME

globus_gram_client_job_contact_free

SYNOPSIS

package require globus_gram_client

globus_gram_client_job_contact_free job_contact

DESCRIPTION

This command is used to release the resources storing a job contact string.

PARAMETERS

RETURN VALUE

On success globus_gram_client_job_contact_free returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gram_client_job_contact_free $job_contact ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_job_request


[Functions] globus_gram_client/globus_gram_client_job_refresh_credentials

[top][index]

NAME

globus_gram_client_job_refresh_credentials

SYNOPSIS

package require globus_gram_client

globus_gram_client_job_refresh_credentials job_contact credential

DESCRIPTION

This command is used to delegate new credentials to a job manager.

This command performs a new delegation handshake with the job manager, updating it with a new user proxy. This will allow the job manager to continue to send job state callbacks after the original proxy would have expired.

PARAMETERS

RETURN VALUE

On success globus_gram_client_job_refresh_credentials returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL NULL ] result job_contact

lassign [ globus_gram_client_job_refresh_credentials $job_contact $gss_c_no_credential ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_register_job_refresh_credentials.


[Functions] globus_gram_client/globus_gram_client_job_request

[top][index]

NAME

globus_gram_client_job_request

SYNOPSIS

package require globus_gram_client

globus_gram_client_job_request resource_manager_contact description job_state_mask callback_contact

DESCRIPTION

This command is used to request a job to be started (blocking).

Request access to interactive resources at the current time. A job request is atomic: either all of the requested processes are created, or none are created.

PARAMETERS

RETURN VALUE

On success globus_gram_client_job_request returns 0 and job_contact. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/date)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL $callback_contact ] result job_contact

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free.


[Functions] globus_gram_client/globus_gram_client_job_signal

[top][index]

NAME

globus_gram_client_job_signal

SYNOPSIS

package require globus_gram_client

globus_gram_client_job_signal job_contact signal signal_arg

DESCRIPTION

This command is used to send a signal to a GRAM job manager to modify the way it handles a job request. Signals consist of a signal number, and an optional string argument. The meanings of the signals supported by the GRAM job manager are defined in the GRAM Protocol documentation

PARAMETERS

RETURN VALUE

On success globus_gram_client_job_signal returns 0, job_status and failure_code. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL $callback_contact ] result job_contact

lassign [ globus_gram_client_job_signal $job_contact $GLOBUS_GRAM_PROTOCOL_JOB_SIGNAL_STOP_MANAGER NULL ] result job_status job_failure_code

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_register_job_signal.


[Functions] globus_gram_client/globus_gram_client_job_status

[top][index]

NAME

globus_gram_client_job_status

SYNOPSIS

package require globus_gram_client

globus_gram_client_job_status job_contact

DESCRIPTION

This command is used to query the status of the job associated with the job contact, returning it's current job status and job failure reason if it has failed.

PARAMETERS

RETURN VALUE

On success globus_gram_client_job_status returns 0, job_status and failure_code. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL $callback_contact ] result job_contact

lassign [ globus_gram_client_job_status $job_contact ] result job_status job_failure_code

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_register_job_status.


[Functions] globus_gram_client/globus_gram_client_ping

[top][index]

NAME

globus_gram_client_ping

SYNOPSIS

package require globus_gram_client

globus_gram_client_ping resource_manager_contact

DESCRIPTION

This command is used to verify that a gatekeeper is running.

This command sends a specially-formated GRAM protocol message which checks to see if a Globus Gatekeeper is running on a given PORT, and whether that Gatekeeper is configured to support the desired job manager service. This is primarily used for diagnostic purposes.

This command blocks while processing the ping request.

PARAMETERS

RETURN VALUE

On success globus_gram_client_ping returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

lassign [ globus_gram_client_ping $resource_manager_contact ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_register_ping


[Functions] globus_gram_client/globus_gram_client_register_job_callback_registration

[top][index]

NAME

globus_gram_client_register_job_callback_registration

SYNOPSIS

package require globus_gram_client

globus_gram_client_register_job_callback_registration job_contact job_state_mask callback_contact attr script

DESCRIPTION

This command is used to register a callback contact for job state changes (nonblocking).

PARAMETERS

RETURN VALUE

On success globus_gram_client_register_job_callback_registration returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL NULL ] result job_contact

set job_state_mask [ expr $GLOBUS_GRAM_PROTOCOL_JOB_STATE_FAILED | $GLOBUS_GRAM_PROTOCOL_JOB_STATE_DONE ]

lassign [ globus_gram_client_register_job_callback_registration $job_contact $job_state_mask $callback_contact NULL { job_registration_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_register_job_callback_unregistration.


[Functions] globus_gram_client/globus_gram_client_register_job_callback_unregistration

[top][index]

NAME

globus_gram_client_register_job_callback_unregistration

SYNOPSIS

package require globus_gram_client

globus_gram_client_register_job_callback_unregistration job_contact callback_contact attr script

DESCRIPTION

This command is used to unregister a callback contact (nonblocking).

PARAMETERS

RETURN VALUE

On success globus_gram_client_register_job_callback_unregistration returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL NULL ] result job_contact

set job_state_mask [ expr $GLOBUS_GRAM_PROTOCOL_JOB_STATE_FAILED | $GLOBUS_GRAM_PROTOCOL_JOB_STATE_DONE ]

lassign [ globus_gram_client_register_job_callback_unregistration $job_contact $callback_contact NULL { job_registration_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_register_job_callback_registration.


[Functions] globus_gram_client/globus_gram_client_register_job_cancel

[top][index]

NAME

globus_gram_client_register_job_cancel

SYNOPSIS

package require globus_gram_client

globus_gram_client_register_job_cancel job_contact attr script

DESCRIPTION

This command is used to cancel of a GRAM-managed job (nonblocking).

Removes a PENDING job request, or kills all processes associated with an ACTIVE job, releasing any associated resources.

PARAMETERS

RETURN VALUE

On success globus_gram_client_register_job_cancel returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL $callback_contact ] result job_contact

lassign [ globus_gram_client_register_job_cancel $job_contact NULL { job_cancel_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_job_cancel.


[Functions] globus_gram_client/globus_gram_client_register_job_refresh_credentials

[top][index]

NAME

globus_gram_client_register_job_refresh_credentials

SYNOPSIS

package require globus_gram_client

globus_gram_client_register_job_refresh_credentials job_contact credential attr script

DESCRIPTION

This command is used to delegate new credentials to a job manager (nonblocking).

This command performs the same operation as globus_gram_client_job_refresh_credentials, but without blocking the calling thread. Once the delegation has completed, it's final status will be reported in the script.

PARAMETERS

RETURN VALUE

On success globus_gram_client_register_job_refresh_credentials returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL NULL ] result job_contact

lassign [ globus_gram_client_register_job_refresh_credentials $job_contact $gss_c_no_credential NULL { job_registration_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_job_refresh_credentials.


[Functions] globus_gram_client/globus_gram_client_register_job_request

[top][index]

NAME

globus_gram_client_register_job_request

SYNOPSIS

package require globus_gram_client

globus_gram_client_register_job_request resource_manager_contact description job_state_mask callback_contact attr script

DESCRIPTION

This command is used to request a job to be started (nonblocking).

Request access to interactive resources at the current time. A job request is atomic: either all of the requested processes are created, or none are created. This is the nonblocking version of globus_gram_client_job_request. Instead of waiting for the job manager to acknowledge that the job has been submitted or started, this command immediately returns after beginning the job submission. The script will be called to let the caller know whether the job request has been submitted successfully or not.

If this command determines that the job request could not be processed before contacting the job manager (for example, a malformed resource_manager_contact) it will return an error, and the script will not be called.

PARAMETERS

RETURN VALUE

On success globus_gram_client_register_job_request returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/date)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_register_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL $callback_contact NULL { job_request_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free.


[Functions] globus_gram_client/globus_gram_client_register_job_signal

[top][index]

NAME

globus_gram_client_register_job_signal

SYNOPSIS

package require globus_gram_client

globus_gram_client_register_job_signal job_contact signal signal_arg attr script

DESCRIPTION

This command is used to send a nonblocking signal to a GRAM job manager to modify the way it handles a job request. Signals consist of a signal number, and an optional string argument. The meanings of the signals supported by the GRAM job manager are defined in the GRAM Protocol documentation.

PARAMETERS

RETURN VALUE

On success globus_gram_client_register_job_signal returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL $callback_contact ] result job_contact

lassign [ globus_gram_client_register_job_signal $job_contact $GLOBUS_GRAM_PROTOCOL_JOB_SIGNAL_STOP_MANAGER NULL NULL { job_signal_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_register_job_signal.


[Functions] globus_gram_client/globus_gram_client_register_job_status

[top][index]

NAME

globus_gram_client_register_job_status

SYNOPSIS

package require globus_gram_client

globus_gram_client_register_job_status job_contact attr script

DESCRIPTION

This command is used to query the status of the job associated with the job contact, returning it's current job status and job failure reason if it has failed.

PARAMETERS

RETURN VALUE

On success globus_gram_client_register_job_status returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

set job_description "&(executable=/bin/sleep)(arguments=300)"

lassign [ globus_gram_client_callback_allow { done_cb NULL } ] status callback_contact

lassign [ globus_gram_client_job_request $resource_manager_contact $job_description $GLOBUS_GRAM_PROTOCOL_JOB_STATE_ALL $callback_contact ] result job_contact

lassign [ globus_gram_client_register_job_status $job_contact NULL { job_status_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_callback_allow, globus_gram_client_callback_disallow, globus_gram_client_job_request, globus_gram_client_register_job_request, globus_gram_client_job_contact_free, globus_gram_client_job_status.


[Functions] globus_gram_client/globus_gram_client_register_ping

[top][index]

NAME

globus_gram_client_register_ping

SYNOPSIS

package require globus_gram_client

globus_gram_client_register_ping resource_manager_contact attr script

DESCRIPTION

This command is used to verify that a gatekeeper is running (nonblocking).

This command sends a specially-formated GRAM protocol message which checks to see if a Globus Gatekeeper is running on a given PORT, and whether that Gatekeeper is configured to support the desired job manager service. This is primarily used for diagnostic purposes.

If this command determines that the ping could not be processed before contacting the gatekeeper (for example, a malformed resource_manager_contact), it will return an error, and the script will not be called.

PARAMETERS

RETURN VALUE

On success globus_gram_client_register_ping returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

set resource_manager_contact "bosco.ligo.caltech.edu:51939:/DC=org/DC=doegrids/OU=People/CN=Michael Samidi 288621"

lassign [ globus_gram_client_register_ping $resource_manager_contact NULL { register_ping_cb NULL } ] result

BUGS

None

TODO

None

SEE ALSO

globus_gram_client_ping


[Functions] globus_gram_client/globus_gram_client_set_credentials

[top][index]

NAME

globus_gram_client_set_credentials

SYNOPSIS

package require globus_gram_client

globus_gram_client_set_credentials new_credential

DESCRIPTION

This command is used to set new credentials.

RETURN VALUE

On success globus_gram_client_set_credentials returns 0. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gram_client_set_credentials $gss_c_no_credential ] result

BUGS

None

TODO

None


[Functions] globus_gram_client/globus_gram_client_version

[top][index]

NAME

globus_gram_client_version

SYNOPSIS

package require globus_gram_client

globus_gram_client_version

DESCRIPTION

This command is used to check the version of the GRAM protocol which this implementation of the GRAM client library understands.

RETURN VALUE

On success globus_gram_client_version returns an integer representing the protocol version. On error, this command will raise an error and must be caught using the appropriate catch command.

EXAMPLE

lassign [ globus_gram_client_version ] result version

BUGS

None

TODO

None