Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Bagian sebelumnya menyediakan sampel dan panduan untuk memulai proyek Anda termasuk:
- Membuat templat sederhana.
- Menerapkan kelas Objek Layanan yang dapat dikompilasi dan dilihat oleh aplikasi sampel Point Of Service melalui PosExplorer.
- Menerapkan kelas pembantu utas.
Sampel ini menggabungkan semua langkah ini untuk membuat kelas Objek Layanan MSR multithreaded yang berfungsi. Sampel ini sebenarnya tidak dibaca dari perangkat keras apa pun. Ini hanya mengalirkan data uji melalui sistem. Namun, ini menggambarkan cara menambahkan kode yang khusus untuk Objek Layanan Anda.
Untuk menyesuaikan kode ini untuk Objek Layanan Anda
PosAssemblyUbah atribut di AssemblyInfo.cs sehingga berisi nama organisasi Anda.Pastikan bahwa nama namespace layanan sesuai untuk organisasi dan Objek Layanan Anda.
ServiceObjectUbah atribut agar berisi jenis, nama, deskripsi, dan nomor versi Objek Layanan yang Anda buat.HardwareIdTambahkan atribut untuk mengaitkan Objek Layanan ini dengan perangkat Plug and Play, atau berbagai perangkat.Sertakan kelas ThreadHelper yang diperkenalkan dalam Thread Pembaca Objek Layanan. Anda dapat melakukan ini dengan menempelkan kode ke dalam file sumber Anda, atau mengkompilasinya sebagai file sumber terpisah dalam proyek Anda. Pastikan kelas ThreadHelper berada di namespace layanan yang dapat diakses.
Terapkan anggota yang diperlukan tergantung pada kelas Dasar yang digunakan oleh Objek Layanan dan fungsionalitas yang ingin Anda dukung. Sampel ini adalah Objek Layanan MSR yang berfungsi dengan fungsionalitas yang sangat sedikit.
Persyaratan
Untuk mengkompilasi sampel ini, proyek Anda harus memiliki referensi dan atribut global yang benar. Jika Anda belum membuat POS yang berfungsi untuk Objek Layanan .NET, tinjau bagian Sampel Objek Layanan: Memulai .
Selain itu, Anda juga harus menyertakan kode dari bagian sebelumnya, Memperkenalkan Utas Pembaca Objek Layanan, ke dalam proyek Anda.
Menunjukkan
Sebagian besar Objek Layanan perlu menggunakan utas kedua untuk memantau perangkat keras dan memberi tahu aplikasi berbagai peristiwa data masuk. Sampel ini menunjukkan salah satu cara untuk membuat Objek Layanan multithreaded. Ini bergantung pada kelas ServiceObjectThreadHelper yang dibahas dalam Memperkenalkan Utas Pembaca Objek Layanan dalam melakukan hal ini.
Untuk menggunakan kelas pembantu, aplikasi perlu menentukan kelas baru yang mengimplementasikan antarmuka ServiceObjectThreadHelper . Antarmuka ini mencakup tiga metode:
- ServiceObjectThreadOpen Metode ini dipanggil selama inisialisasi utas dan harus digunakan untuk menginisialisasi sumber daya khusus perangkat keras apa pun.
- ServiceObjectThreadClose Metode ini dipanggil ketika utas dihentikan dan harus digunakan untuk merilis sumber daya khusus perangkat keras apa pun.
- ServiceObjectThreadProcedure Metode ini akan dipanggil setelah utas berhasil dimulai dan harus terus-menerus menunggu peristiwa perangkat keras, serta tidak boleh keluar hingga ManualEvent yang tepat dipicu.
Kode ini dibangun pada sampel yang disajikan dalam topik Membuat Sampel Objek Layanan dan menambahkan fitur berikut:
- Membuat kelas yang berasal dari ServiceObjectThreadHelper.
- Membuat sebuah instans dari kelas MsrThreadingObject. Konstruktor untuk kelas ini mengambil satu argumen, referensi ke objek layanan.
- Memanggil metode pada objek MsrThreadingObject dari Objek Layanan untuk memulai dan menghentikan pengelola utas sesuai kebutuhan.
Example
using System;
using System.Threading;
using Microsoft.PointOfService;
using Microsoft.PointOfService.BaseServiceObjects;
using System.Text;
namespace Samples.ServiceObjects.Advanced.MSR
{
public class MsrThreadingObject :
ServiceObjectThreadHelper, IDisposable
{
// This is a helper class which will depend on
// being able to call back into the actual Service
// Object to pass along data. However, you cannot
// keep a strong reference to the Service Object,
// since that will prevent proper disposal, which
// may create a state in which all hardware resources
// are not properly released by the SO. Therefore,
// create a weak reference. From this reference,
// you can get a temporary strong reference, which
// you act on and then release.
WeakReference ServiceObjectReference;
// The name of the Service Object.
string ObjectName;
public MsrThreadingObject(AdvancedSampleMsr so)
{
ObjectName = GetType().Name;
ServiceObjectReference = new WeakReference(so);
}
~MsrThreadingObject()
{
Dispose(true);
}
private bool IsDisposed = false;
protected virtual void Dispose(bool disposing)
{
if (!IsDisposed)
{
IsDisposed = true;
base.Dispose(disposing);
}
}
public void Dispose()
{
Dispose(false);
}
#region Methods of ServiceObjectThreadHelper
// This will be called during initialization.
public override void ServiceObjectThreadOpen()
{
Logger.Info(ObjectName, "Msr Thread Open");
}
// This method will be called during shutdown.
public override void ServiceObjectThreadClose()
{
Logger.Info(ObjectName, "Msr Thread Open");
}
public override void ServiceObjectThreadProcedure(
AutoResetEvent ThreadStopEvent)
{
// Convert a C# string into a sample byte array.
UTF8Encoding encoder = new UTF8Encoding();
// Convert sample data to a byte array.
byte[] MsrData = encoder.GetBytes(
"This is MSR test data");
Logger.Info(ObjectName, "Msr Thread Procedure Entered");
while (true)
{
// When this method is called by the
// ServiceObjectThreadHelper, it is obligated to
// exit when the event ThreadStopEvent has been
// set.
// Additionally, this method will also wait for
// hardware events or for a time-out. That should
// be done here.
// This example waits for the event to be set
// or times out after several seconds.
if (ThreadStopEvent.WaitOne(2000, false))
{
break;
}
Logger.Info(ObjectName, "Reader Thread cycling");
// Try to get a strong reference to the Service
// Object using the weak reference saved when
// this helper object was created.
AdvancedSampleMsr msr =
ServiceObjectReference.Target
as AdvancedSampleMsr;
// If this fails, that means the Service
// Object has already been disposed of. Exit the
// thread.
if (msr == null)
{
break;
}
// Using the strong reference, you can now make
// calls back into the Service Object.
msr.OnCardSwipe(MsrData);
msr = null;
}
#endregion Methods of ServiceObjectThreadHelper
}
// Implementation of the Service Object class. This class
// implements all the methods needed for an MSR Service
// Object.
//
// A Service Object which supports a Plug and Play device
// should also have a HardwareId attribute here.
[HardwareId(
@"HID\Vid_05e0&Pid_038a",
@"HID\Vid_05e0&Pid_038a")]
[ServiceObject(
DeviceType.Msr,
"AdvancedSampleMsr",
"Advanced Sample Msr Service Object",
1,
9)]
public class AdvancedSampleMsr : MsrBase
{
// String returned for various health checks.
private string MyHealthText;
private const string PollingStatistic =
"Polling Interval";
// Create a class with interface methods called from the
// threading object.
MsrThreadingObject ReadThread;
public AdvancedSampleMsr()
{
// DevicePath must be set before Open() is called.
// In the case of Plug and Play hardware, the POS
// for .NET Base class will set this value.
DevicePath = "Sample Msr";
Properties.CapIso = true;
Properties.CapTransmitSentinels = true;
Properties.DeviceDescription =
"Advanced Sample Msr";
// Initialize the string to be returned from
// CheckHealthText().
MyHealthText = "";
}
~AdvancedSampleMsr()
{
// Code added from previous sections to terminate
// the read thread started by the thread-helper
// object.
ReadThread.CloseThread();
Dispose(false);
}
protected override void Dispose(bool disposing)
{
try
{
if (disposing)
{
if (ReadThread != null)
{
ReadThread.Dispose();
ReadThread = null;
}
}
}
finally
{
// Must call base class Dispose.
base.Dispose(disposing);
}
}
#region Internal Members
// This is a private method called from the task
// interface when a data event occurs in the reader
// thread.
internal void OnCardSwipe(byte[] CardData)
{
// Simple sample data.
UTF8Encoding utf8 = new UTF8Encoding();
byte[] track1Data = utf8.GetBytes(
"this is test track 1");
byte[] track2Data = utf8.GetBytes(
"this is test track 2");
// Call GoodRead(), UnreadableCard, or FailedRead
// from here.
GoodRead(
track1Data,
track2Data,
null,
null,
Microsoft.PointOfService.BaseServiceObjects.CardType.Iso);
}
#endregion Internal Members
#region PosCommon overrides
// PosCommon.Open.
public override void Open()
{
// Call base class Open.
base.Open();
// Initialize statistic values.
// Set values for common statistics.
SetStatisticValue(StatisticManufacturerName,
"Microsoft Corporation");
SetStatisticValue(
StatisticManufactureDate, "2004-10-23");
SetStatisticValue(
StatisticModelName, "Msr Simulator");
SetStatisticValue(
StatisticMechanicalRevision, "1.0");
SetStatisticValue(
StatisticInterface, "USB");
// Create a new manufacturer statistic.
CreateStatistic(
PollingStatistic,
false,
"milliseconds");
// Set handlers for statistics stored in hardware.
// Create a class with interface methods called
// from the threading object.
ReadThread = new MsrThreadingObject(this);
}
// PosCommon.CheckHealthText.
public override string CheckHealthText
{
get
{
// MsrBasic.VerifyState(mustBeClaimed,
// mustBeEnabled).
VerifyState(false, false);
return MyHealthText;
}
}
// PosCommon.CheckHealth.
public override string CheckHealth(
HealthCheckLevel
level)
{
// Verify that device is open, claimed, and enabled.
VerifyState(true, true);
// Your code here checks the health of the device and
// returns a descriptive string.
// Cache result in the CheckHealthText property.
MyHealthText = "Ok";
return MyHealthText;
}
// PosCommon.DirectIO.
public override DirectIOData DirectIO(
int command,
int data,
object obj)
{
return new DirectIOData(data, obj);
}
public override bool DeviceEnabled
{
get
{
return base.DeviceEnabled;
}
set
{
if (value != base.DeviceEnabled)
{
base.DeviceEnabled = value;
if (value == false)
{
// Stop the reader thread when the
// device is disabled.
ReadThread.CloseThread();
}
else
{
try
{
// Enabling the device, start the
// reader thread.
ReadThread.OpenThread();
}
catch (Exception e)
{
base.DeviceEnabled = false;
if (e is PosControlException)
throw;
throw new PosControlException(
"Unable to Enable Device",
ErrorCode.Failure, e);
}
}
}
}
}
#endregion PosCommon overrides.
#region MsrBasic Overrides
// MsrBasic.MsrFieldData
// Once the track data is retrieved, this method is
// called when the application accesses various data
// properties in the MsrBasic class. For example,
// FirstName and AccountNumber.
protected override MsrFieldData ParseMsrFieldData(
byte[] track1Data,
byte[] track2Data,
byte[] track3Data,
byte[] track4Data,
CardType cardType)
{
// MsrFieldData contains the data elements that
// MsrBasic will return as properties to the
// application, as they are requested.
MsrFieldData data = new MsrFieldData();
// Parse the raw track data and store in fields to
// be used by the app.
data.FirstName = "FirstName";
data.Surname = "LastName";
data.Title = "Mr.";
data.AccountNumber = "123412341234";
return data;
}
// MsrBasic.MsrTrackData.
protected override MsrTrackData ParseMsrTrackData(
byte[] track1Data,
byte[] track2Data,
byte[] track3Data,
byte[] track4Data,
CardType cardType)
{
MsrTrackData data = new MsrTrackData();
// Modify the track data as appropriate for your SO.
// Remove the sentinel characters from the track data,
// for example.
data.Track1Data = (byte[])track1Data.Clone();
data.Track2Data = (byte[])track2Data.Clone();
return data;
}
#endregion MsrBasic overrides
}
}
}