Class: Win32::Daemon
- Inherits:
-
Object
- Object
- Win32::Daemon
- Extended by:
- Windows::ServiceFunctions, Windows::ServiceStructs
- Defined in:
- lib/win32/daemon.rb
Overview
The Daemon class
Constant Summary collapse
Constants included from Windows::ServiceConstants
Windows::ServiceConstants::DELETE, Windows::ServiceConstants::ERROR_FILE_NOT_FOUND, Windows::ServiceConstants::ERROR_INSUFFICIENT_BUFFER, Windows::ServiceConstants::ERROR_MORE_DATA, Windows::ServiceConstants::ERROR_RESOURCE_NAME_NOT_FOUND, Windows::ServiceConstants::ERROR_RESOURCE_TYPE_NOT_FOUND, Windows::ServiceConstants::FORMAT_MESSAGE_FROM_SYSTEM, Windows::ServiceConstants::FORMAT_MESSAGE_IGNORE_INSERTS, Windows::ServiceConstants::IDLE_CONTROL_CODE, Windows::ServiceConstants::INFINITE, Windows::ServiceConstants::NO_ERROR, Windows::ServiceConstants::SC_ACTION_NONE, Windows::ServiceConstants::SC_ACTION_REBOOT, Windows::ServiceConstants::SC_ACTION_RESTART, Windows::ServiceConstants::SC_ACTION_RUN_COMMAND, Windows::ServiceConstants::SC_ENUM_PROCESS_INFO, Windows::ServiceConstants::SC_MANAGER_ALL_ACCESS, Windows::ServiceConstants::SC_MANAGER_CONNECT, Windows::ServiceConstants::SC_MANAGER_CREATE_SERVICE, Windows::ServiceConstants::SC_MANAGER_ENUMERATE_SERVICE, Windows::ServiceConstants::SC_MANAGER_LOCK, Windows::ServiceConstants::SC_MANAGER_MODIFY_BOOT_CONFIG, Windows::ServiceConstants::SC_MANAGER_QUERY_LOCK_STATUS, Windows::ServiceConstants::SC_STATUS_PROCESS_INFO, Windows::ServiceConstants::SERVICE_ACCEPT_HARDWAREPROFILECHANGE, Windows::ServiceConstants::SERVICE_ACCEPT_NETBINDCHANGE, Windows::ServiceConstants::SERVICE_ACCEPT_PARAMCHANGE, Windows::ServiceConstants::SERVICE_ACCEPT_PAUSE_CONTINUE, Windows::ServiceConstants::SERVICE_ACCEPT_POWEREVENT, Windows::ServiceConstants::SERVICE_ACCEPT_PRESHUTDOWN, Windows::ServiceConstants::SERVICE_ACCEPT_SESSIONCHANGE, Windows::ServiceConstants::SERVICE_ACCEPT_SHUTDOWN, Windows::ServiceConstants::SERVICE_ACCEPT_STOP, Windows::ServiceConstants::SERVICE_ACCEPT_TIMECHANGE, Windows::ServiceConstants::SERVICE_ACCEPT_TRIGGEREVENT, Windows::ServiceConstants::SERVICE_ACTIVE, Windows::ServiceConstants::SERVICE_ADAPTER, Windows::ServiceConstants::SERVICE_ALL_ACCESS, Windows::ServiceConstants::SERVICE_AUTO_START, Windows::ServiceConstants::SERVICE_BOOT_START, Windows::ServiceConstants::SERVICE_CHANGE_CONFIG, Windows::ServiceConstants::SERVICE_CONFIG_DELAYED_AUTO_START_INFO, Windows::ServiceConstants::SERVICE_CONFIG_DESCRIPTION, Windows::ServiceConstants::SERVICE_CONFIG_FAILURE_ACTIONS, Windows::ServiceConstants::SERVICE_CONFIG_FAILURE_ACTIONS_FLAG, Windows::ServiceConstants::SERVICE_CONFIG_PRESHUTDOWN_INFO, Windows::ServiceConstants::SERVICE_CONFIG_REQUIRED_PRIVILEGES_INFO, Windows::ServiceConstants::SERVICE_CONFIG_SERVICE_SID_INFO, Windows::ServiceConstants::SERVICE_CONTINUE_PENDING, Windows::ServiceConstants::SERVICE_CONTROL_CONTINUE, Windows::ServiceConstants::SERVICE_CONTROL_DEVICEEVENT, Windows::ServiceConstants::SERVICE_CONTROL_HARDWAREPROFILECHANGE, Windows::ServiceConstants::SERVICE_CONTROL_INTERROGATE, Windows::ServiceConstants::SERVICE_CONTROL_NETBINDADD, Windows::ServiceConstants::SERVICE_CONTROL_NETBINDDISABLE, Windows::ServiceConstants::SERVICE_CONTROL_NETBINDENABLE, Windows::ServiceConstants::SERVICE_CONTROL_NETBINDREMOVE, Windows::ServiceConstants::SERVICE_CONTROL_PARAMCHANGE, Windows::ServiceConstants::SERVICE_CONTROL_PAUSE, Windows::ServiceConstants::SERVICE_CONTROL_POWEREVENT, Windows::ServiceConstants::SERVICE_CONTROL_PRESHUTDOWN, Windows::ServiceConstants::SERVICE_CONTROL_SESSIONCHANGE, Windows::ServiceConstants::SERVICE_CONTROL_SHUTDOWN, Windows::ServiceConstants::SERVICE_CONTROL_STOP, Windows::ServiceConstants::SERVICE_CONTROL_TIMECHANGE, Windows::ServiceConstants::SERVICE_CONTROL_TRIGGEREVENT, Windows::ServiceConstants::SERVICE_DEMAND_START, Windows::ServiceConstants::SERVICE_DISABLED, Windows::ServiceConstants::SERVICE_DRIVER, Windows::ServiceConstants::SERVICE_ENUMERATE_DEPENDENTS, Windows::ServiceConstants::SERVICE_ERROR_CRITICAL, Windows::ServiceConstants::SERVICE_ERROR_IGNORE, Windows::ServiceConstants::SERVICE_ERROR_NORMAL, Windows::ServiceConstants::SERVICE_ERROR_SEVERE, Windows::ServiceConstants::SERVICE_FILE_SYSTEM_DRIVER, Windows::ServiceConstants::SERVICE_INACTIVE, Windows::ServiceConstants::SERVICE_INTERACTIVE_PROCESS, Windows::ServiceConstants::SERVICE_INTERROGATE, Windows::ServiceConstants::SERVICE_KERNEL_DRIVER, Windows::ServiceConstants::SERVICE_NO_CHANGE, Windows::ServiceConstants::SERVICE_PAUSED, Windows::ServiceConstants::SERVICE_PAUSE_CONTINUE, Windows::ServiceConstants::SERVICE_PAUSE_PENDING, Windows::ServiceConstants::SERVICE_QUERY_CONFIG, Windows::ServiceConstants::SERVICE_QUERY_STATUS, Windows::ServiceConstants::SERVICE_RECOGNIZER_DRIVER, Windows::ServiceConstants::SERVICE_RUNNING, Windows::ServiceConstants::SERVICE_START, Windows::ServiceConstants::SERVICE_START_PENDING, Windows::ServiceConstants::SERVICE_STATE_ALL, Windows::ServiceConstants::SERVICE_STOP, Windows::ServiceConstants::SERVICE_STOPPED, Windows::ServiceConstants::SERVICE_STOP_PENDING, Windows::ServiceConstants::SERVICE_SYSTEM_START, Windows::ServiceConstants::SERVICE_TYPE_ALL, Windows::ServiceConstants::SERVICE_USER_DEFINED_CONTROL, Windows::ServiceConstants::SERVICE_WIN32, Windows::ServiceConstants::SERVICE_WIN32_OWN_PROCESS, Windows::ServiceConstants::SERVICE_WIN32_SHARE_PROCESS, Windows::ServiceConstants::SE_PRIVILEGE_ENABLED, Windows::ServiceConstants::TOKEN_ADJUST_PRIVILEGES, Windows::ServiceConstants::TOKEN_QUERY, Windows::ServiceConstants::WAIT_FAILED, Windows::ServiceConstants::WAIT_OBJECT_0, Windows::ServiceConstants::WAIT_TIMEOUT
Class Method Summary collapse
-
.mainloop ⇒ Object
This is a shortcut for Daemon.new + Daemon#mainloop.
Instance Method Summary collapse
-
#mainloop ⇒ Object
This is the method that actually puts your code into a loop and allows it to run as a service.
-
#running? ⇒ Boolean
Returns whether or not the service is in a running state, i.e.
-
#state ⇒ Object
Returns the state of the service (as an constant integer) which can be any of the service status constants, e.g.
Class Method Details
.mainloop ⇒ Object
This is a shortcut for Daemon.new + Daemon#mainloop.
214 215 216 |
# File 'lib/win32/daemon.rb', line 214 def self.mainloop self.new.mainloop end |
Instance Method Details
#mainloop ⇒ Object
This is the method that actually puts your code into a loop and allows it to run as a service. The code that is actually run while in the mainloop is what you defined in your own Daemon#service_main method.
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'lib/win32/daemon.rb', line 222 def mainloop @@waiting_control_code = IDLE_CONTROL_CODE @@dwServiceState = 0 # Redirect STDIN, STDOUT and STDERR to the NUL device if they're still # associated with a tty. This helps newbs avoid Errno::EBADF errors. STDIN.reopen('NUL') if STDIN.isatty STDOUT.reopen('NUL') if STDOUT.isatty STDERR.reopen('NUL') if STDERR.isatty # Calling init here so that init failures never even tries to start the # service. Of course that means that init methods must be very quick # because the SCM will be receiving no START_PENDING messages while # init's running. # # TODO: Fix? service_init() if respond_to?('service_init') # Create the event to signal the service to start. @@hStartEvent = CreateEvent(nil, 1, 0, nil) if @@hStartEvent == 0 raise SystemCallError.new('CreateEvent', FFI.errno) end # Create the event to signal the service to stop. @@hStopEvent = CreateEvent(nil, 1, 0, nil) if @@hStopEvent == 0 raise SystemCallError.new('CreateEvent', FFI.errno) end # Create the event to signal the service that stop has completed @@hStopCompletedEvent = CreateEvent(nil, 1, 0, nil) if @@hStopCompletedEvent == 0 raise SystemCallError.new('CreateEvent', FFI.errno) end hThread = CreateThread(nil, 0, ThreadProc, Service_Main, 0, nil) if hThread == 0 raise SystemCallError.new('CreateThread', FFI.errno) end events = FFI::MemoryPointer.new(:pointer, 2) events.put_pointer(0, FFI::Pointer.new(hThread)) events.put_pointer(FFI::Pointer.size, FFI::Pointer.new(@@hStartEvent)) while ((index = WaitForMultipleObjects(2, events, 0, 1000)) == WAIT_TIMEOUT) do end if index == WAIT_FAILED raise SystemCallError.new('WaitForMultipleObjects', FFI.errno) end # The thread exited, so the show is off. if index == WAIT_OBJECT_0 raise "Service_Main thread exited abnormally" end thr = Thread.new do begin while(WaitForSingleObject(@@hStopEvent, 1000) == WAIT_TIMEOUT) # Check to see if anything interesting has been signaled case @@waiting_control_code when SERVICE_CONTROL_PAUSE service_pause() if respond_to?('service_pause') when SERVICE_CONTROL_CONTINUE service_resume() if respond_to?('service_resume') when SERVICE_CONTROL_INTERROGATE service_interrogate() if respond_to?('service_interrogate') when SERVICE_CONTROL_SHUTDOWN service_shutdown() if respond_to?('service_shutdown') when SERVICE_CONTROL_PARAMCHANGE service_paramchange() if respond_to?('service_paramchange') when SERVICE_CONTROL_NETBINDADD service_netbindadd() if respond_to?('service_netbindadd') when SERVICE_CONTROL_NETBINDREMOVE service_netbindremove() if respond_to?('service_netbindremove') when SERVICE_CONTROL_NETBINDENABLE service_netbindenable() if respond_to?('service_netbindenable') when SERVICE_CONTROL_NETBINDDISABLE service_netbinddisable() if respond_to?('service_netbinddisable') end @@waiting_control_code = IDLE_CONTROL_CODE end service_stop() if respond_to?('service_stop') ensure SetEvent(@@hStopCompletedEvent) end end if respond_to?('service_main') service_main(*@@Argv) end thr.join end |
#running? ⇒ Boolean
Returns whether or not the service is in a running state, i.e. the service status is either RUNNING, PAUSED or IDLE.
This is typically used within your service_main method to setup the main loop. For example:
class MyDaemon < Daemon
def service_main
while running?
# Your main loop here
end
end
end
358 359 360 |
# File 'lib/win32/daemon.rb', line 358 def running? [SERVICE_RUNNING, SERVICE_PAUSED, 0].include?(@@dwServiceState) end |
#state ⇒ Object
Returns the state of the service (as an constant integer) which can be any of the service status constants, e.g. RUNNING, PAUSED, etc.
This method is typically used within your service_main method to setup the loop. For example:
class MyDaemon < Daemon
def service_main
while state == RUNNING || state == PAUSED || state == IDLE
# Your main loop here
end
end
end
See the Daemon#running? method for an abstraction of the above code.
339 340 341 |
# File 'lib/win32/daemon.rb', line 339 def state @@dwServiceState end |