com.SecurePlay.Comms.SPCLocalCommsFile
Class SPCLocalCommsFileClass

java.lang.Object
  com.SecurePlay.Comms.SPAbstractCommsClass
      com.SecurePlay.Comms.SPCLocalCommsFile.SPCLocalCommsFileClass

All Implemented Interfaces:

java.lang.Runnable, SPAbstractCommsInterface

Direct Known Subclasses:

SPCLocalCommsFileBinaryClass

public class SPCLocalCommsFileClass

extends SPAbstractCommsClass

implements java.lang.Runnable

This class handles communications between multiple instances of the SecurePlay library on a single computer. This is an easy way to test or implement multiplayer games with a single design. This version uses files to exchange data rather than simply instances so that it can be used with different sessions or different languages, if message encodings are uniform.

Author:

IT GlobalSecure

See Also:

SecurePlay License Information

Field Summary

Fields inherited from class com.SecurePlay.Comms.SPAbstractCommsClass

commstype

Constructor Summary

SPCLocalCommsFileClass()
Default Constructor

Method Summary

boolean	APIactivate() This method adds the Local Comms instance to the set of active Local Comms objects so it will receive incoming messages
boolean	APIconfigureCommService(int pollp) Configures the comms service.
boolean	APIdeactivate() This method removes the Local Comms instance from the set of active local Comms objects so it can no longer send or receive messages NOTE: Deactivate for threads does not actually delete the thread.
boolean	APIsetDirPath(java.lang.String str) This method sets the directory path for the various local comms classes that communicate via shared files
java.lang.String	getCommsServiceType() This method gets the comms service type
boolean	prsend(java.lang.String message) This method sends messages to each of the registered Local Comms instances
void	run()

Methods inherited from class com.SecurePlay.Comms.SPAbstractCommsClass

addGame, addPlayer, APIconfigureCommService, getCommsID, getGameplayerList, getInternalGameIDList, getPrinternalGameList, isGameInternal, logError, processincoming, prreceive, removeGame, removePlayer, sendMessage, sendMessage, setcommsID, SPdeserialize, SPserialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SPCLocalCommsFileClass

public SPCLocalCommsFileClass()

Default Constructor

Method Detail

getCommsServiceType

public java.lang.String getCommsServiceType()

This method gets the comms service type

Specified by:

getCommsServiceType in interface SPAbstractCommsInterface

Overrides:

getCommsServiceType in class SPAbstractCommsClass

Returns:

"local" - String - local

prsend

public boolean prsend(java.lang.String message)

This method sends messages to each of the registered Local Comms instances

Overrides:

prsend in class SPAbstractCommsClass

Parameters:

message - String - the message to be sent.

Returns:

boolean - true, if successful

APIactivate

public boolean APIactivate()

This method adds the Local Comms instance to the set of active Local Comms objects so it will receive incoming messages

Overrides:

APIactivate in class SPAbstractCommsClass

Returns:

boolean - Boolean: TRUE, if successful, FALSE, if not successful

APIdeactivate

public boolean APIdeactivate()

This method removes the Local Comms instance from the set of active local Comms objects so it can no longer send or receive messages NOTE: Deactivate for threads does not actually delete the thread.

Overrides:

APIdeactivate in class SPAbstractCommsClass

Returns:

boolean - Boolean: TRUE, if successful, FALSE, if not successful

run

public void run()

Specified by:

run in interface java.lang.Runnable

APIsetDirPath

public boolean APIsetDirPath(java.lang.String str)

This method sets the directory path for the various local comms classes that communicate via shared files

Parameters:

str - - proposed directory path

Returns:

boolean - true, if successful

APIconfigureCommService

public boolean APIconfigureCommService(int pollp)

Configures the comms service.

Parameters:

pollp - int - the polling period to be scheduled to.

Returns:

boolean Boolean: TRUE, if successful, FALSE, if not successful