[This is preliminary documentation and is subject to change.]
The ShippoSystem type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | ShippoSystem(String, IConfigSectionNode) | Initializes a new instance of the ShippoSystem class |
![]() | ShippoSystem(String, IConfigSectionNode, Object) | Initializes a new instance of the ShippoSystem class |
Methods
Name | Description | |
---|---|---|
![]() | ____ObtainPrivateServiceStatusLockObject |
WARNING: Developers never call this method!!!
It is used by advanced derived implementations that need to synchronize status updates.
We do not want to make statuslock protected as it is almost never needed, hence this accessor
(Inherited from Service.) |
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | AbortStart |
Allows to abort unsuccessful DoStart() overridden implementation.
This method must be called from within DoStart()
(Inherited from Service.) |
![]() | AcceptManagerVisit |
Accepts a visit of a manager entity - this call is useful for periodic updates of service status,
i.e. when service does not have a thread of its own it can be periodically managed by some other service through this method.
The default implementation of DoAcceptManagerVisit(object, DateTime) does nothing
(Inherited from Service.) |
![]() | CheckForCompleteStop |
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from Service.) |
![]() | CheckServiceActive |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceActiveOrStarting |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceInactive |
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
(Inherited from Service.) |
![]() | Configure |
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.) |
![]() | CreateLabel(ShippingSession, IShippingContext, Shipment) | (Overrides ShippingSystem CreateLabel(ShippingSession, IShippingContext, Shipment).) |
![]() | CreateLabel(ShippoSession, IShippingContext, Shipment) | |
![]() | Destructor | (Inherited from ShippingSystem.) |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | DoAcceptManagerVisit | (Inherited from ShippingSystem.) |
![]() | DoCheckForCompleteStop |
Provides implementation for checking whether the service has completely stopped
(Inherited from Service.) |
![]() | DoConfigure | (Inherited from ShippingSystem.) |
![]() | DoSignalStop |
Provides implementation that signals service to stop. This is expected not to block
(Inherited from Service.) |
![]() | DoStart | (Inherited from ShippingSystem.) |
![]() | DoStartSession | (Overrides ShippingSystem DoStartSession(ShippingConnectionParameters).) |
![]() | DoWaitForCompleteStop | (Inherited from ShippingSystem.) |
![]() | EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | EstimateShippingCost(ShippingSession, IShippingContext, Shipment) | (Overrides ShippingSystem EstimateShippingCost(ShippingSession, IShippingContext, Shipment).) |
![]() | EstimateShippingCost(ShippoSession, IShippingContext, Shipment) | |
![]() | ExternalGetParameter |
Gets external parameter value returning true if parameter was found
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | ExternalParametersForGroups |
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | ExternalSetParameter |
Sets external parameter value returning true if parameter was found and set
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | Finalize | (Inherited from DisposableObject.) |
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | GetShippingCarriers | (Inherited from ShippingSystem.) |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | LocalizedTimeToUniversalTime |
Converts localized time to UTC time as of TimeLocation property
(Inherited from Service.) |
![]() | Log | (Inherited from ShippingSystem.) |
![]() | MakeDefaultSessionConnectParams | (Overrides ShippingSystem MakeDefaultSessionConnectParams(IConfigSectionNode).) |
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | SignalStop |
Non-blocking call that initiates the stopping of the service
(Inherited from Service.) |
![]() | Start |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | StartByApplication |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | StartSession | (Inherited from ShippingSystem.) |
![]() | StatCreateLabel | (Inherited from ShippingSystem.) |
![]() | StatCreateLabelError | (Inherited from ShippingSystem.) |
![]() | StatEstimateShippingCostCount | (Inherited from ShippingSystem.) |
![]() | StatEstimateShippingCostErrorCount | (Inherited from ShippingSystem.) |
![]() | StatTrackShipmentCount | (Inherited from ShippingSystem.) |
![]() | StatTrackShipmentErrorCount | (Inherited from ShippingSystem.) |
![]() | StatValidateAddressCount | (Inherited from ShippingSystem.) |
![]() | StatValidateAddressErrorCount | (Inherited from ShippingSystem.) |
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
![]() | TrackShipment(ShippingSession, IShippingContext, String, String) | (Overrides ShippingSystem TrackShipment(ShippingSession, IShippingContext, String, String).) |
![]() | TrackShipment(ShippoSession, IShippingContext, String, String) | |
![]() | UniversalTimeToLocalizedTime |
Converts universal time to local time as of TimeLocation property
(Inherited from Service.) |
![]() | ValidateAddress(ShippingSession, IShippingContext, Address, ValidateShippingAddressException ) | (Overrides ShippingSystem ValidateAddress(ShippingSession, IShippingContext, Address, ValidateShippingAddressException ).) |
![]() | ValidateAddress(ShippoSession, IShippingContext, Address, ValidateShippingAddressException ) | |
![]() | WaitForCompleteStop |
Blocks execution of current thread until this service has completely stopped
(Inherited from Service.) |
Extension Methods
Fields
Properties
Name | Description | |
---|---|---|
![]() | ApplicationDontAutoStartService |
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
(Inherited from Service.) |
![]() | ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.) |
![]() | ComponentDirector | (Inherited from Service TDirector .) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) |
![]() | ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) |
![]() | DefaultSessionConnectParams | (Inherited from ShippingSystem.) |
![]() | DefaultSessionConnectParamsCfg | (Inherited from ShippingSystem.) |
![]() | Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) |
![]() | DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) |
![]() | ExternalParameters |
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | InstrumentationEnabled | (Inherited from ShippingSystem.) |
![]() | KeepAlive | (Inherited from ShippingSystem.) |
![]() | LocalizedTime |
Returns current time localized per TimeLocation
(Inherited from Service.) |
![]() | LogLevel | (Inherited from ShippingSystem.) |
![]() | Name |
Provides textual name for the service
(Inherited from Service.) |
![]() | Pipelined | (Inherited from ShippingSystem.) |
![]() | Running |
Returns true when service is active or about to become active.
Check in service implementation loops/threads/tasks
(Inherited from Service.) |
![]() | Sessions | (Inherited from ShippingSystem.) |
![]() | Status |
Current service status
(Inherited from Service.) |
![]() | TimeLocation |
Returns time location of this LocalizedTimeProvider implementation
(Inherited from Service.) |
![]() | WebServiceCallTimeoutMs | (Inherited from ShippingSystem.) |
See Also