This class contains all the operations that Avilible for a Service. Since this class is abstract, Servuce object is invlaid and can't be constructed. A Service handle is created by SPI class interface. All data in this class is reachable through various methods which define the behaivor of the operation. More...

#include <Service.h>

Public Member Functions
virtual SPILIBRARY_API SPI_RET_VAL	Init (string DeviceSerialNo)=0
	Initialize the payment service.

virtual SPILIBRARY_API SPI_RET_VAL	DoEstablishment (string Retailer)=0
	Establishes the service and makes it ready for use, considering database, etc. Must be called once or in case unestablished indication is received as a result of GetServiceStatus().

virtual SPILIBRARY_API SPI_RET_VAL	AbortDoEstablishment ()=0
	Abort establishment process while occuring.Has to be called by another thread.

virtual SPILIBRARY_API SPI_RET_VAL	AddPinpad (PPIDType PinPadID, Config &PinpadConfig, PP_Protocol Protocol, bool IsDirect)=0
	That method, called by an administrator as part of the system configuration, Adds and configure a single Pinpad device to the Pinpad list. Each device is identified by unique integer number. This method must be called before device can perfoem any transaction with the payment service and must be called at least once, as Pinpad map is empty at stage of service initialization.

virtual SPILIBRARY_API SPI_RET_VAL	StartTransaction (Transaction *TransactionPtr)=0
	That non blocking method is called in order to start transaction with a well initiated transaction. The method returns right away. Each started transaction with this method must call at lwast once to PollTransaction() to know when to go to CloseTransaction().

virtual SPILIBRARY_API SPI_RET_VAL	PollTransaction (Transaction *TransactionPtr, TransactionStatus &Status)=0
	That non blocking method is called in order to poll the status of a transaction. The method returns right away. The status is returned via output parameter Status. Loyalty is supported through the method SetLoyaltyAmount(). If transaction is aborted using AbortTransaction(), still calling CloseTransaction is mandatory.

virtual SPILIBRARY_API SPI_RET_VAL	CloseTransaction (Transaction *TransactionPtr)=0
	That non blocking method is called in order to end the transaction handeled by TransactionPtr. The method returns right away. This method is mandatory for each transaction started with StartTransaction(). If transaction is aborted using AbortTransaction(), calling CloseTransaction is still mandatory.

virtual SPILIBRARY_API SPI_RET_VAL	DoTransaction (Transaction *TransactionPtr)=0
	That blocking method is called in order to perform the the whole process of transaction with a well initiated transaction. The method returns only when transaction is done weather successfuly or not.

virtual SPILIBRARY_API SPI_RET_VAL	DoTransactionPhase1 (Transaction *TransactionPtr)=0
	That blocking method is called in order to perform the first phase of a well initiated transaction. The method returns only when first phase is terminated successfuly or not. Completing successfully that method, enables the caller to set a discounted sub total,using ChangeLoyaltyAmount(Amount), before completing the transaction. That event is known as "Loyalty" event considering the retail terminology. After calling that method,the user should call to DoTransactionPhase2 in order to complete the transaction.

virtual SPILIBRARY_API SPI_RET_VAL	DoTransactionPhase2 (Transaction *TransactionPtr)=0
	Blocking method to perfoem the second phase of a transaction. Method returns only when transaction is completely done, Weather or not Transaction was succeded. This method does all the requiered calls to pinpads.

virtual SPILIBRARY_API SPI_RET_VAL	AbortTransaction (Transaction *TransactionPtr)=0
	Abort an ongoing transaction. If executed via a blocking method, can be called from a another thread. Once called on handle that executed via blocking method, the call to AbortTransaction will cause the blocking method to return right away on the other thread. If called on a nonblocking API, all needed is go to close the transaction.

virtual SPILIBRARY_API SPI_RET_VAL	RetrieveTransaction (Transaction *TransactionPtr, std::string UID)=0
	Get information about transaction given a UID. if UID is empty (aka UID=""), function will retreive last successfull transaction.

virtual SPILIBRARY_API SPI_RET_VAL	StartEndOfDay (Report *ReportResult)=0
	That non blocking method is called in order to start end of day process. The method returns right away. Each started end of day call mest at least once go to PollEndOfDay() to know when to go to CloseEndOfDay().

virtual SPILIBRARY_API SPI_RET_VAL	PollEndOfDay (Report *ReportResult, EndOfDayStatus &Status)=0
	That non blocking method is called in order to poll end of day process. The method returns right away. with the status of the operaiton in Status output param. If operation aborted using AbortBlockingOperation() a call to CloseEndOfDay() is mandatory.

virtual SPILIBRARY_API SPI_RET_VAL	CloseEndOfDay (Report *ReportResult)=0
	That non blocking method is called in order to close nonblocking end of day process. The method returns right away. If operation aborted using AbortBlockingOperation() a call to CloseEndOfDay() is mandatory.

virtual SPILIBRARY_API SPI_RET_VAL	EndOfDay (Report *ReportResult)=0
	End of day function is batching all transactions to Service processor. This method is blocking and returns only when batching was ended.

virtual SPILIBRARY_API SPI_RET_VAL	AbortEndOfDay ()=0
	Abort an ongoing EndOfDay. If executed via a blocking method, can be called from a another thread. Once called while executed via blocking method, the call to AbortEndOfDay will cause the blocking method to return right away on the other thread. If called on a nonblocking API, all needed is go to close the EndOfday.

virtual SPILIBRARY_API ExtendedPeriodicStatus	GetExtendedPeriodicStatus (CounterType &BlockNumber, std::string &Text) const =0
	Get specific status of periodic (EndOfDay or Establishment) according to the comm states.

virtual SPILIBRARY_API SPI_RET_VAL	DoReport (Report *ReportResult)=0
	Get a detailed Report from the Service. There are 2 kinds of reports:

virtual SPILIBRARY_API SPI_RET_VAL	DoEraseDB ()=0
	Erase service database. All transactions in Service database must be batched via EndOfDay bedore operation.

virtual SPILIBRARY_API SPI_RET_VAL	DisplayCustomerDisplay (PPIDType DeviceID, vector< string > Messages)=0
	Display up to 3 lines of text on specific Pinpad. Pinpad must be connected direct to service. (See AddPinpad(...) for more details) Each line will be element in std::vector and may not contain CR, LF or CRLF Each line will be up to 19 characters not including null terminator.

virtual SPILIBRARY_API SPI_RET_VAL	ClearPinpadMap ()=0
	Delete all pinpads which added via AddPinpad()

virtual SPILIBRARY_API SPI_RET_VAL	CheckPinpadConnection (PPIDType PinpadID)=0
	Check wheather a pinpad which added via AddPinpad() is responding and avilible to do operations.

virtual SPILIBRARY_API void	GetServiceVersion (std::string &Version) const =0
	Get Service version by providing a buffuer std::string to write the result.

virtual SPILIBRARY_API string	GetSerialID () const =0
	Get the serial number provided when service initiated.

virtual SPILIBRARY_API string	GetRetailerID () const =0
	Get the Retailer number in use of current Service processor.

virtual SPILIBRARY_API string	GetRetailerName () const =0
	Get the Retailer name in use of current Service processor as established.

SPILIBRARY_API string	GetLastErrorMessage () const
	Get last error message produced by the Service. Should be called when SPI_FAIL is returned from a Service method.

virtual SPILIBRARY_API string	GetUIDbyVUID (std::string VUID) const =0
	Get transaction UID by VUID supplied to Transaction object.

SPILIBRARY_API boolean	IsServiceAvailable () const
	Get status of service communication regarding it's configuration provided in it's Config when Added to SPI.

virtual SPILIBRARY_API boolean	IsReadyForTransaction () const
	Use this method before performing a transaction. To get more details you may use GetServiceStatus()

virtual SPILIBRARY_API SPI_STATUS	GetServiceStatus ()=0
	Get service status.

SPILIBRARY_API string	GetName () const
	Get service name asw defined while added to SPI.

virtual SPILIBRARY_API string	GetProperty (ServiceProperty Property) const =0
	Get service property in string format. the follow properties are supported:

	Service (string, Config &)
	Constructor reserved for internal useage.

virtual	~Service ()
	destructor reserved for internal useage

APIHandle	GetServiceHandle () const
	Handle get - reserved for internal useage.

Protected Attributes
APIHandle	ServiceHandle

Detailed Description

This class contains all the operations that Avilible for a Service. Since this class is abstract, Servuce object is invlaid and can't be constructed. A Service handle is created by SPI class interface. All data in this class is reachable through various methods which define the behaivor of the operation.

Examples:: CPP_Examples.cpp.

Definition at line 36 of file Service.h.

Member Function Documentation

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::AbortDoEstablishment ( )

pure virtual

Abort establishment process while occuring.Has to be called by another thread.

Returns

SPI_SUCCESS : Abortd successfully
SPI_INVALID : An error occurred

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::AbortEndOfDay ( )

pure virtual

Abort an ongoing EndOfDay. If executed via a blocking method, can be called from a another thread. Once called while executed via blocking method, the call to AbortEndOfDay will cause the blocking method to return right away on the other thread. If called on a nonblocking API, all needed is go to close the EndOfday.

Returns

SPI_SUCCESS if abortion is ok.
- SPI_FAIL if EndofDay is in state that can't be abort anymore.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::AbortTransaction ( Transaction * TransactionPtr )

pure virtual

Abort an ongoing transaction. If executed via a blocking method, can be called from a another thread. Once called on handle that executed via blocking method, the call to AbortTransaction will cause the blocking method to return right away on the other thread. If called on a nonblocking API, all needed is go to close the transaction.

Parameters

[in,out] TransactionPtr is a pointer to Transaction handle constructed by a matching derived class.

Returns

SPI_SUCCESS if abortion is ok
SPI_FAIL if transaction is in state that can't be abort anymore

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::AddPinpad	(	PPIDType	PinPadID,
		Config &	PinpadConfig,
		PP_Protocol	Protocol,
		bool	IsDirect
	)

pure virtual

That method, called by an administrator as part of the system configuration, Adds and configure a single Pinpad device to the Pinpad list. Each device is identified by unique integer number. This method must be called before device can perfoem any transaction with the payment service and must be called at least once, as Pinpad map is empty at stage of service initialization.

Parameters

[in]	PinPadID	is a unique number for device identification
[in]	PinpadConfig	is Config instance to set device location
[in]	Protocol	is Pinpad Protocol
[in]	IsDirect	is Pinpad connected direct to service (true) or unsupprted by the service (false)

Returns

SPI_SUCCESS : Pinpad added
SPI_ALREADY_EXIST : Pinpad already exist
SPI_FAIL : Handle error
SPI_NO_INIT : Service not initialized properly

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::CheckPinpadConnection ( PPIDType PinpadID )

pure virtual

Check wheather a pinpad which added via AddPinpad() is responding and avilible to do operations.

Parameters

[in] PinpadID is the Pinpad identification number attached to a device that added via AddPinpad()

Returns

SPI_SUCCESS if device is responding.
SPI_FAIL if device isn't responding.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::ClearPinpadMap ( )

pure virtual

Delete all pinpads which added via AddPinpad()

Returns

SPI_SUCCESS if operation succeded.
- SPI_FAIL if no pinpads are exist.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::CloseEndOfDay ( Report * ReportResult )

pure virtual

That non blocking method is called in order to close nonblocking end of day process. The method returns right away. If operation aborted using AbortBlockingOperation() a call to CloseEndOfDay() is mandatory.

Parameters

[in,out] ReportResult is a pointer to Result handle constructed with Z_REPORT.

Returns

SPI_SUCCESS is returned when operation started OK.
SPI_FAIL is returned when a method shouldn't be called. See GetLastErrorMessage() output to get detailed information.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::CloseTransaction ( Transaction * TransactionPtr )

pure virtual

That non blocking method is called in order to end the transaction handeled by TransactionPtr. The method returns right away. This method is mandatory for each transaction started with StartTransaction(). If transaction is aborted using AbortTransaction(), calling CloseTransaction is still mandatory.

Parameters

[in,out] TransactionPtr is a pointer to Transaction handle constructed by a matching derived class.

Returns

SPI_SUCCESS is returned when the transaction process was OK, weather transaction was succeded or not.
SPI_FAIL is returned when a method shouldn't be called. See GetLastErrorMessage() output to get detailed information.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::DisplayCustomerDisplay	(	PPIDType	DeviceID,
		vector< string >	Messages
	)

pure virtual

Display up to 3 lines of text on specific Pinpad. Pinpad must be connected direct to service. (See AddPinpad(...) for more details) Each line will be element in std::vector and may not contain CR, LF or CRLF Each line will be up to 19 characters not including null terminator.

Parameters

[in]	DeviceID	is Pinpad Id to display messeges
[in]	Messages	is std::vector<std::string> - vector of strings as describes

Returns

SPI_SUCCESS if operation succeded.
- SPI_FAIL Pinpad not found or not responding.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::DoEraseDB ( )

pure virtual

Erase service database. All transactions in Service database must be batched via EndOfDay bedore operation.

Returns

SPI_SUCCESS if erase succeded.
- SPI_INVALID if there are transactions in database that haven't batched yet.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::DoEstablishment ( string Retailer )

pure virtual

Establishes the service and makes it ready for use, considering database, etc. Must be called once or in case unestablished indication is received as a result of GetServiceStatus().

Parameters

[in] Retailer is Retailer number given by the service processor.

Returns

SPI_SUCCESS : Retailer established successfully.
SPI_INVALID : An error occurred

Examples:: CPP_Examples.cpp.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::DoReport ( Report * ReportResult )

pure virtual

Get a detailed Report from the Service. There are 2 kinds of reports:

            - X_REPORT to get the current status in the Service
            - Z_REPORT to get last Report created during EndOfDay.

Parameters

[in,out] ReportResult is a pointer to Report object which constructed with the matching ReportType.

Returns

SPI_SUCCESS if report succeded.
SPI_FAIL if no report is avilible ot there are no registered transactions in the Service database.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::DoTransaction ( Transaction * TransactionPtr )

pure virtual

That blocking method is called in order to perform the the whole process of transaction with a well initiated transaction. The method returns only when transaction is done weather successfuly or not.

Parameters

[in,out] TransactionPtr is a pointer to Transaction handle constructed by a matching derived class.

Returns

SPI_SUCCESS is returned when the transaction process was OK, weather transaction was succeded or not.
SPI_INVALID is returned while fail to register the transaction in SPI module.
SPI_FAIL is returned when a method shouldn't be called. See GetLastErrorMessage() output to get detailed information.
SPI_ABORT when transaction aborted by the user
SPI_TIME_OUT when connection to the processor timed out.

Examples:: CPP_Examples.cpp.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::DoTransactionPhase1 ( Transaction * TransactionPtr )

pure virtual

That blocking method is called in order to perform the first phase of a well initiated transaction. The method returns only when first phase is terminated successfuly or not. Completing successfully that method, enables the caller to set a discounted sub total,using ChangeLoyaltyAmount(Amount), before completing the transaction. That event is known as "Loyalty" event considering the retail terminology. After calling that method,the user should call to DoTransactionPhase2 in order to complete the transaction.

Parameters

[in,out] TransactionPtr is a pointer to Transaction handle constructed by a matching derived class.

Returns

SPI_SUCCESS is returned when the transaction process was OK, weather transaction was succeded or not.
SPI_INVALID is returned while fail to register the transaction in SPI module.
SPI_FAIL is returned when a method shouldn't be called. See GetLastErrorMessage() output to get detailed information.
SPI_ABORT when transaction aborted by the user
SPI_TIME_OUT when connection to the processor timed out.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::DoTransactionPhase2 ( Transaction * TransactionPtr )

pure virtual

Blocking method to perfoem the second phase of a transaction. Method returns only when transaction is completely done, Weather or not Transaction was succeded. This method does all the requiered calls to pinpads.

Parameters

[in,out] TransactionPtr is a pointer to Transaction handle constructed by a matching derived class.

Returns

SPI_SUCCESS is returned when the transaction process was OK, weather transaction was succeded or not.
SPI_INVALID is returned while fail to register the transaction in SPI module.
SPI_FAIL is returned when a method shouldn't be called. See GetLastErrorMessage() output to get detailed information.
SPI_ABORT when transaction aborted by the user
SPI_TIME_OUT when connection to the processor timed out.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::EndOfDay ( Report * ReportResult )

pure virtual

End of day function is batching all transactions to Service processor. This method is blocking and returns only when batching was ended.

Parameters

[in,out] ReportResult is a Report constructed with Z_REPORT. In order to receive the report created by the processor.

Returns

SPI_SUCCESS when batching was ok
SPI_FAIL otherwise
SPI_TIME_OUT when connection to the processor timed out.

Examples:: CPP_Examples.cpp.

virtual SPILIBRARY_API ExtendedPeriodicStatus Modularity::SPI::Service::GetExtendedPeriodicStatus	(	CounterType &	BlockNumber,
		std::string &	Text
	)		const

pure virtual

Get specific status of periodic (EndOfDay or Establishment) according to the comm states.

Parameters

[out]	BlockNumber	indicates block number in case of PeriodicStatus_RecvBlockedCardsResponseFull
[out]	Text	for display the curreny status in Hebrew UTF-8. Text changes every time the status is updated of the block number increase by 1.

Returns: ExtendedPeriodicStatus Enum

SPILIBRARY_API string Modularity::SPI::Service::GetLastErrorMessage ( ) const

Get last error message produced by the Service. Should be called when SPI_FAIL is returned from a Service method.

Returns: Hebrew string in UTF-8 specifing the error.

SPILIBRARY_API string Modularity::SPI::Service::GetName ( ) const

Get service name asw defined while added to SPI.

Returns: std::string with Name.

virtual SPILIBRARY_API string Modularity::SPI::Service::GetProperty ( ServiceProperty Property ) const

pure virtual

Get service property in string format. the follow properties are supported:

Properties
Name	format	example
ServiceProperty_TransmitTime	epoch time_t	1485869256

Parameters

[in] PropertyName to get.

Returns: std::string with property. if string is empty property wasn't found.

virtual SPILIBRARY_API string Modularity::SPI::Service::GetRetailerID ( ) const

pure virtual

Get the Retailer number in use of current Service processor.

Returns: string with retailer number. If empty than service may not established.

virtual SPILIBRARY_API string Modularity::SPI::Service::GetRetailerName ( ) const

pure virtual

Get the Retailer name in use of current Service processor as established.

Returns: string with retailer name. If empty than service may not established.

virtual SPILIBRARY_API string Modularity::SPI::Service::GetSerialID ( ) const

pure virtual

Get the serial number provided when service initiated.

Returns: string with serial number number. If empty than service is not initiated.

virtual SPILIBRARY_API SPI_STATUS Modularity::SPI::Service::GetServiceStatus ( )

pure virtual

Get service status.

Returns

SPI_READY means SPI is ready to do transactions and different operaitons.
SPI_READY_ONLINE just like SPI_READY but processor will be notified about each transaction.
SPI_NOT_ESTABLISHED means DoEstablishment() should be called.
SPI_NOT_READY means EndOfDay() must be called.
SPI_ERROR means unknown error occurred.

Examples:: CPP_Examples.cpp.

virtual SPILIBRARY_API void Modularity::SPI::Service::GetServiceVersion ( std::string & Version ) const

pure virtual

Get Service version by providing a buffuer std::string to write the result.

Parameters

[out] Version is the buffer where the result is written.

virtual SPILIBRARY_API string Modularity::SPI::Service::GetUIDbyVUID ( std::string VUID ) const

pure virtual

Get transaction UID by VUID supplied to Transaction object.

Parameters

[in] VUID to look for.

Returns: std::string with UID. if string is empty VUID wasn't found.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::Init ( string DeviceSerialNo )

pure virtual

Initialize the payment service.

Parameters

[in] DeviceSerialNo - Device serial number.Considering AshraitEMV service, that runs over the user device such as library, that must be sent.

Returns

SPI_SUCCESS : Service initialization was OK.
SPI_INVALID : An error occurred

See Also: InitAshraitExample()

Examples:: CPP_Examples.cpp.

virtual SPILIBRARY_API boolean Modularity::SPI::Service::IsReadyForTransaction ( ) const

virtual

Use this method before performing a transaction. To get more details you may use GetServiceStatus()

Returns: Wheather service is able to perform a transaction.

SPILIBRARY_API boolean Modularity::SPI::Service::IsServiceAvailable ( ) const

Get status of service communication regarding it's configuration provided in it's Config when Added to SPI.

Returns: Wheather service communicates with it's endpoint.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::PollEndOfDay	(	Report *	ReportResult,
		EndOfDayStatus &	Status
	)

pure virtual

That non blocking method is called in order to poll end of day process. The method returns right away. with the status of the operaiton in Status output param. If operation aborted using AbortBlockingOperation() a call to CloseEndOfDay() is mandatory.

Parameters

[in,out]	ReportResult	is a pointer to Result handle constructed with Z_REPORT.
[out]	Status	is the operation status EndOfDay_NotCompleted - Keep poll EndOfDay_Completed - done, call CloseEndOfDay()

Returns

SPI_SUCCESS is returned when operation started OK.
SPI_FAIL is returned when a method shouldn't be called. See GetLastErrorMessage() output to get detailed information.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::PollTransaction	(	Transaction *	TransactionPtr,
		TransactionStatus &	Status
	)

pure virtual

That non blocking method is called in order to poll the status of a transaction. The method returns right away. The status is returned via output parameter Status. Loyalty is supported through the method SetLoyaltyAmount(). If transaction is aborted using AbortTransaction(), still calling CloseTransaction is mandatory.

Parameters

[in,out]	TransactionPtr	is a pointer to Transaction handle constructed by a matching derived class.
[out]	Status	is the status of the transaction which handeled by TransactionPtr. Tran_NotCompleted - Need to keep polling Tran_Phase1Now - need to keep polling, before poll user can change loyalty amount according to information he has in this state of the transaction. Tran_Completed - Need to call CloseTransaction()

Returns

SPI_SUCCESS is returned when the transaction process was OK, weather transaction was succeded or not.
SPI_INVALID is returned while fail to register the transaction in SPI module.
SPI_FAIL is returned when a method shouldn't be called. See GetLastErrorMessage() output to get detailed information.
SPI_ABORT when transaction aborted by the user

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::RetrieveTransaction	(	Transaction *	TransactionPtr,
		std::string	UID
	)

pure virtual

Get information about transaction given a UID. if UID is empty (aka UID=""), function will retreive last successfull transaction.

Parameters

[in,out]	TransactionPtr	is a pointer to Transaction handle constructed by a matching derived class with Matching VirtualReason.
[in]	UID	is the transaction identifer created by the service.

Returns

SPI_SUCCESS if transaction was found / last transaction exists
SPI_FAIL if no transactions are exist or UID wasn't found.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::StartEndOfDay ( Report * ReportResult )

pure virtual

That non blocking method is called in order to start end of day process. The method returns right away. Each started end of day call mest at least once go to PollEndOfDay() to know when to go to CloseEndOfDay().

Parameters

[in,out] ReportResult is a pointer to Result handle constructed with Z_REPORT.

Returns

SPI_SUCCESS is returned when operation started OK.
SPI_FAIL is returned when a method shouldn't be called. See GetLastErrorMessage() output to get detailed information.

virtual SPILIBRARY_API SPI_RET_VAL Modularity::SPI::Service::StartTransaction ( Transaction * TransactionPtr )

pure virtual

That non blocking method is called in order to start transaction with a well initiated transaction. The method returns right away. Each started transaction with this method must call at lwast once to PollTransaction() to know when to go to CloseTransaction().

Parameters

[in,out] TransactionPtr is a pointer to Transaction handle constructed by a matching derived class.

Returns

SPI_SUCCESS is returned when the transaction process was OK, weather transaction was succeded or not.
SPI_INVALID is returned while fail to register the transaction in SPI module.
SPI_FAIL is returned when a method shouldn't be called. See GetLastErrorMessage() output to get detailed information.
SPI_ABORT when transaction aborted by the user

Member Data Documentation

APIHandle Modularity::SPI::Service::ServiceHandle

protected

Handle

Definition at line 441 of file Service.h.

The documentation for this class was generated from the following file:

Service.h

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation