com.jniwrapper.win32.service
Class Service.Status

java.lang.Object
  extended by com.jniwrapper.Parameter
      extended by com.jniwrapper.Structure
          extended by com.jniwrapper.win32.service.Service.Status
All Implemented Interfaces:
com.jniwrapper.AlignmentAwareParameter, com.jniwrapper.CompositeParameter
Enclosing class:
Service

public static class Service.Status
extends com.jniwrapper.Structure

This class represents the service status.


Nested Class Summary
static class Service.Status.ControlsAccepted
           
 
Field Summary
 
Fields inherited from class com.jniwrapper.Structure
i
 
Fields inherited from class com.jniwrapper.Parameter
LICENSE_TYPE, V
 
Constructor Summary
Service.Status()
           
Service.Status(Service.Status that)
           
 
Method Summary
 java.lang.Object clone()
           
 long getCheckPoint()
          Returns check-point value the service increments periodically to report its progress during a lengthy start, stop, pause, or continue operation.
 Service.Status.ControlsAccepted getControlsAccepted()
          Returns control codes the service accepts and processes in its handler function.
 Service.CurrentState getCurrentState()
          Returns the current state of the service.
 long getServiceSpecificExitCode()
          Returns service-specific error code that the service returns when an error occurs while the service is starting or stopping.
 Service.Type getServiceType()
          Returns type of the service.
 long getWaitHint()
          Returns estimated time required for a pending start, stop, pause, or continue operation, in milliseconds.
 long getWin32ExitCode()
          Returns error code the service uses to report an error that occurs when it is starting or stopping.
 void setServiceType(Service.Type serviceType)
          Sets type of the service.
 
Methods inherited from class com.jniwrapper.Structure
a, a, acceptIOPerformer, addMembers, computeLength, equals, getAlignmentRequirement, getDebugInfo, getFirstMemberSize, getLength, getMember, getMembers, getOffsets, init, init, initFrom, pop, push, read, setDataBuffer, write
 
Methods inherited from class com.jniwrapper.Parameter
, a, asReturnValue, b, dataBufferAssigned, getAlignedLength, getDataBuffer, getDataBufferOffset, hashCode, indent, read, read, toByteArray, write
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Service.Status

public Service.Status(Service.Status that)

Service.Status

public Service.Status()
Method Detail

getServiceType

public Service.Type getServiceType()
Returns type of the service.

Returns:
service type.

setServiceType

public void setServiceType(Service.Type serviceType)
Sets type of the service.

Parameters:
serviceType - type of service.

getCurrentState

public Service.CurrentState getCurrentState()
Returns the current state of the service.

Returns:
current state of service.

getControlsAccepted

public Service.Status.ControlsAccepted getControlsAccepted()
Returns control codes the service accepts and processes in its handler function.

Returns:
control codes accepted by the service.

getWin32ExitCode

public long getWin32ExitCode()
Returns error code the service uses to report an error that occurs when it is starting or stopping.

Returns:
error code of the service.

getServiceSpecificExitCode

public long getServiceSpecificExitCode()
Returns service-specific error code that the service returns when an error occurs while the service is starting or stopping.

Returns:
exit code of the service if an error occurred.

getCheckPoint

public long getCheckPoint()
Returns check-point value the service increments periodically to report its progress during a lengthy start, stop, pause, or continue operation.

Returns:
value that indicates start, stop or pause progress.

getWaitHint

public long getWaitHint()
Returns estimated time required for a pending start, stop, pause, or continue operation, in milliseconds.

Returns:
estimated start, stop, pause time in milliseconds.

clone

public java.lang.Object clone()
Overrides:
clone in class com.jniwrapper.Structure