Class: Rubyfb::ServiceManager
- Inherits:
-
Object
- Object
- Rubyfb::ServiceManager
- Defined in:
- lib/src.rb
Overview
This class represents a connection to the service manager for a Firebird database server instance. NOTE: This class does not currently work on the Mac OS X platform.
Instance Method Summary collapse
-
#connect(user, password) ⇒ Object
This method attaches a ServiceManager object to its host service.
-
#connected? ⇒ Boolean
This method is used to determine whether a ServiceManager object has been connected.
-
#disconnect ⇒ Object
This method disconnects a previously connected ServiceManager object.
-
#execute(*tasks) ⇒ Object
This method is used to batch execute a collection of task objects.
-
#initialize(host) ⇒ ServiceManager
constructor
This is the constructor for the ServiceManager class.
Constructor Details
#initialize(host) ⇒ ServiceManager
This is the constructor for the ServiceManager class.
Parameters
- host
-
The name of the host supporting the service manager to be connected with.
1328 1329 |
# File 'lib/src.rb', line 1328 def initialize(host) end |
Instance Method Details
#connect(user, password) ⇒ Object
This method attaches a ServiceManager object to its host service. The user name used to connect with can affect which services can be accessed on the server.
Parameters
- user
-
A string containing the user name to connect with.
- password
-
A string containing the user password to connect with.
1341 1342 |
# File 'lib/src.rb', line 1341 def connect(user, password) end |
#connected? ⇒ Boolean
This method is used to determine whether a ServiceManager object has been connected.
1356 1357 |
# File 'lib/src.rb', line 1356 def connected? end |
#disconnect ⇒ Object
This method disconnects a previously connected ServiceManager object.
1348 1349 |
# File 'lib/src.rb', line 1348 def disconnect end |
#execute(*tasks) ⇒ Object
This method is used to batch execute a collection of task objects.
Parameters
- tasks
-
One or more task objects to be executed by the service manager.
Exceptions
- FireRubyException
-
Generated whenever this method is called on a disconnected service manager or is a problem occurs executing one of the tasks.
1371 1372 |
# File 'lib/src.rb', line 1371 def execute(*tasks) end |