Controlling Surpac using TCL over Sockets

//

// The shared memory is created with a name that is built from

// "GemcomSharedMemory" to which is appended the process ID (an unsigned int).

// To construct the name of the shared memory an external program must:

// 1. Iterate through all processes

// 2. For each Surpac, Quarry, MineSched or Xplorpac process that is found

// append the process ID to "GemcomSharedMemory" and then attempt to open

// the shared memory as shown by the example code below.

//

// below is a command to build this program from a Visual Studio command window

//

// cl -RTCcsu -EHsc -Iinclude -Zi -DEBUG -DEBUGTYPE:cv testmem.cpp

//

#include <Windows.h>

#include <stdio.h>

#include <stdlib.h>

#include <sharedmem.h>

#include <string>

/**

* Open a block of shared memory with a specified name.

*

* @param memName [I] The name of the shared memory

* @param lpMapAddress [O] The starting address of the mapped memory. NULL if

* failed to open.

*

* @return Handle to the block of shared memory. 0 if unsuccessful,

* non-zero if successful. Can be used with closeSharedMemory() to

* free resources.

*

*/

HANDLE openSharedMemory(const char *memName, LPVOID *lpMapAddress)

{

HANDLE hMapFile = NULL;

*lpMapAddress = NULL;

hMapFile =

OpenFileMapping(FILE_MAP_READ, // read access only

FALSE, // don't inherit the handle - whatever that means

memName); // name of mapping object

if (hMapFile) {

// now get the shared memory address and write details to shared memory

*lpMapAddress =

MapViewOfFile(hMapFile, // handle to mapping object

FILE_MAP_READ, // read permission

0, // high DWORD to offset to map

0, // low DWORD to offset to map

0); // map the entire file

}

return(hMapFile);

}

/**

* Close reference to a block of shared memory previously opened

* using opeSharedMemory().

*

* @param hMapFile [I] Handle to the shared memory object obtained

* using openSharedMemory()

* @param lpMapAddress [I] The pointer to teh mapped view when it was

* originally mapped. See the lpMapAddress arg of

* openSharedMemory()

*/

void closeSharedMemory(HANDLE hMapFile, LPVOID lpMapAddress)

{

if (lpMapAddress) {

UnmapViewOfFile(lpMapAddress);

}

if (hMapFile) {

CloseHandle(hMapFile);

}

}

/**

* Get the address of the next block of shared memory. Returns NULL if no

* more blocks of memory to process.

*

* @param blockPtr [I] Address of the current block of memory. Initially

* obtained using openSharedMemory()

*

* @return pointer to the next block of shared memory, NULL if no more memory

* blocks available in the shared memory.

*

*/

void *nextSharedMemoryBlock(void *blockPtr)

{

SharedMemBlockInfo *blockInfo;

void *nextBlockPtr;

blockInfo = (SharedMemBlockInfo *)blockPtr;

if (blockInfo != NULL && blockInfo->memBlockSize > 0) {

nextBlockPtr = (void *)(((char *)blockPtr) + blockInfo->memBlockSize);

} else {

nextBlockPtr = NULL;

}

return (nextBlockPtr);

}

/**

* Creates a named block of shared memory to aid discovery of Surpac process

* specifics.

*

* The shared memory block has these characteristics:

*

* The name is "GemcomSharedMemory<unsigned process ID>" - external programs

* can build the name using "GemcomSharedMemory" and appending to it a

* character representation of the unsigned value of the process ID.

*

* Product Info - Memory block ID = 1

* ----------------------------------

* unsigned - Size of the product info memory block

* int - Identifies the ID for the product info memory block

* char[64] - Null terminated string with product name - "Surpac"

* int - Product major version identifier

* int - Product minor version identifier

* int - Product maintenance version identifier

* int - TCP/IP port number for client/server communications

*

* The end of the block of memory is represented by and end marker which has:

* int - end marker - always 0

* int - end marker type always 0

*

*/

int main(int argc, char **argv)

{

// create a named block of shared memory area with a well defined name

// so that external programs can check the contents of the shared memory

// for information about the running executable

//

// This requirement comes the remote control capabilities of the software

// which, to work, need to know what TCP/IP port is being used for

// client/server comms. The port number and other useful items can be

// found in the shared memory

//

//

// see

//ms-help://MS.VSCC.2003/MS.MSDNQTR.2003FEB.1033/fileio/base/creating_named_shared_memory.htm

// for an example of using shared memory

//

HANDLE hMapFile = NULL;

char errText[1024];

char memname[1024];

unsigned pid;

DWORD err;

printf("Enter process id :");

scanf("%u", &pid);

if (pid > 0) {

LPVOID lpMapAddress = NULL;

LPVOID orig_lpMapAddress = NULL;

sprintf(memname, "GemcomSharedMemory%u", pid);

hMapFile = openSharedMemory(memname, &lpMapAddress);

orig_lpMapAddress = lpMapAddress; // the original pointer is required later

// to properly close the mapped view

if (lpMapAddress) {

SharedMemBlockInfo *blockInfo;

do {

blockInfo = (SharedMemBlockInfo *)lpMapAddress;

if (blockInfo->memBlockID == 0) {

SharedMemEndMarker *endMarker = (SharedMemEndMarker *)lpMapAddress;

printf("Shared memory end marker size =%d\n", endMarker->memBlockSize);

printf("Shared memory end marker type =%d\n", endMarker->memBlockID);

break;

} else if (blockInfo->memBlockID == 1) {

// product info memory block

SharedMemProductInfo *productInfo = (SharedMemProductInfo *)lpMapAddress;

printf("\n");

printf("Product info memory size =%u\n", productInfo->blockInfo.memBlockSize);

printf("Product info block ID =%u\n", productInfo->blockInfo.memBlockID);

printf("Product name =%s\n", productInfo->productName);

printf("Product major version =%u\n", productInfo->majorProductVersion);

printf("Product minor version =%u\n", productInfo->minorProductVersion);

printf("Product sub release version =%u\n", productInfo->maintenanceProductVersion);

printf("Server port number =%u\n", productInfo->serverPortNumber);

}

lpMapAddress = nextSharedMemoryBlock(lpMapAddress);

} while (lpMapAddress);

closeSharedMemory(hMapFile, orig_lpMapAddress);

} else {

DWORD err = GetLastError();

FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, 0, err, 0, errText,

sizeof(errText), 0);

}

}

closeSharedmemory(hMapFile);

exit(0);

}

Public Sub ResponseReceived(ByVal command As Integer, _
ByVal response As String)
MsgBox response
End Sub
 
Dim remote = New SurpacRemoteControl(5000)
Dim commandID = remote.runTCLScript("set result 42", "", _
New SurpacRemoteControl.ResponseHandler( _
AddressOf ResponseReceived))