Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface ProtocolLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>

All Known Implementing Classes:

CMProtocols

public interface ProtocolLibrary
extends CMLibrary

Library for supporting various in-line MUD protocols. These include: MSP - MUD Sound Protocol: generated by the server to send sounds to the client for playing. MXP - MUD eXtension Protocol: generated by the server to send formatting, color, sound, and image information to the client MCP - MUD Client Protocol: protocol for client server interaction not supported by simple telnet. MSDP - MUD Server Data Protocol: system for client to request information from the server not readily visible. (over GMCP) GMCP - Generic MUD Communication Protocol - low level protocol

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProtocolLibrary.GMCPCommand	Enumeration of all support GMCP commands
static interface	ProtocolLibrary.MCPPackage	Interface allowing java or javascript plugins to the MCP protocol

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDefaultMXPImage(CMObject O)	MXP Images for each object can go from very specific to general.
byte[]	invokeRoomChangeGmcp(Session session, java.util.Map<java.lang.String,java.lang.Long> reporteds, java.util.Map<java.lang.String,java.lang.Double> supportables)	GMCP appears to support getting a report from the protocol when entering a new room.
boolean	mcp(Session session, java.lang.StringBuilder str, java.lang.String[] mcpKey, java.util.Map<java.lang.String,float[]> clientSupported, java.util.Map<java.lang.String,java.lang.String> keyValuePairs)	Handles an MCP command from the user, modifying the line of text that contains it.
java.lang.String	msp(java.lang.String soundName, int priority)	Generates an MSP sound tag
java.lang.String	mxpImage(Environmental E, java.lang.String parms)	Constructs an official MXP image tag for the given object, with the given parms.
java.lang.String	mxpImage(Environmental E, java.lang.String parms, java.lang.String pre, java.lang.String post)	Constructs an official MXP image tag for the given object, with the given parms, and given pre-image and post-image data.
java.lang.String[]	mxpImagePath(java.lang.String fileName)	Returns the path and filename to an MXP image, given the image filename, presumably full path.
byte[]	pingGmcp(Session session, java.util.Map<java.lang.String,java.lang.Long> reporteds, java.util.Map<java.lang.String,java.lang.Double> supportables)	Called every second from each player session to deal with periodic GMCP reports.
byte[]	pingMsdp(Session session, java.util.Map<java.lang.Object,java.lang.Object> reportables)	Called every second from each player session to deal with periodic MSDP reports.
byte[]	processGmcp(Session session, java.lang.String data, java.util.Map<java.lang.String,java.lang.Double> supportables)	Main entry point to handle GMCP commands from the user
byte[]	processMsdp(Session session, char[] data, int dataSize, java.util.Map<java.lang.Object,java.lang.Object> reportables)	Main entry point to handle MSDP commands from the user

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

msp

java.lang.String msp(java.lang.String soundName,
                     int priority)

Generates an MSP sound tag

Parameters:

soundName - the name of the MSP sound

priority - a bias number for the sound priority

Returns:

the MSP sound tag

mcp

boolean mcp(Session session,
            java.lang.StringBuilder str,
            java.lang.String[] mcpKey,
            java.util.Map<java.lang.String,float[]> clientSupported,
            java.util.Map<java.lang.String,java.lang.String> keyValuePairs)

Handles an MCP command from the user, modifying the line of text that contains it.

Parameters:

session - the session of the user

str - the string containing the command

mcpKey - the MCP key

clientSupported - map of supported features and their versions

keyValuePairs - protocol-specific key value pairs

Returns:

true if all went well, false otherwise

mxpImagePath

java.lang.String[] mxpImagePath(java.lang.String fileName)

Returns the path and filename to an MXP image, given the image filename, presumably full path.

Parameters:

fileName - the full image path

Returns:

an array with the path, then the filename

See Also:

getDefaultMXPImage(CMObject), mxpImage(Environmental, String, String, String), mxpImage(Environmental, String), mxpImagePath(String)

mxpImage

java.lang.String mxpImage(Environmental E,
                          java.lang.String parms)

Constructs an official MXP image tag for the given object, with the given parms.

Parameters:

E - the object to generate an image tag for

parms - MXP image parms

Returns:

"" or a complete MXP image tag

See Also:

getDefaultMXPImage(CMObject), mxpImage(Environmental, String, String, String), mxpImage(Environmental, String), mxpImagePath(String)

mxpImage

java.lang.String mxpImage(Environmental E,
                          java.lang.String parms,
                          java.lang.String pre,
                          java.lang.String post)

Constructs an official MXP image tag for the given object, with the given parms, and given pre-image and post-image data.

Parameters:

E - the object to generate an image tag for

parms - MXP image parms

pre - something to put in front of the IMAGE tag itself

post - something to put after it, usually a space

Returns:

"" or a complete MXP image tag

See Also:

getDefaultMXPImage(CMObject), mxpImage(Environmental, String, String, String), mxpImage(Environmental, String), mxpImagePath(String)

getDefaultMXPImage

java.lang.String getDefaultMXPImage(CMObject O)

MXP Images for each object can go from very specific to general. This function goes through all the various image layers available to a given game object, and returns the most specific one that is defined.

Parameters:

O - the object to get an image for

Returns:

"", or the http image sub-path

See Also:

getDefaultMXPImage(CMObject), mxpImage(Environmental, String, String, String), mxpImage(Environmental, String), mxpImagePath(String)

processMsdp

byte[] processMsdp(Session session,
                   char[] data,
                   int dataSize,
                   java.util.Map<java.lang.Object,java.lang.Object> reportables)

Main entry point to handle MSDP commands from the user

Parameters:

session - the session of the mob to report to

data - the users MSDP sending

dataSize - the size of the sending?

reportables - the 'subscriptions' of the given session

Returns:

null, or bytes to send to the user

See Also:

pingMsdp(Session, Map)

pingMsdp

byte[] pingMsdp(Session session,
                java.util.Map<java.lang.Object,java.lang.Object> reportables)

Called every second from each player session to deal with periodic MSDP reports.

Parameters:

session - the session of the mob to report to

reportables - the 'subscriptions' of the given session

Returns:

null, or bytes to send to the user

See Also:

processMsdp(Session, char[], int, Map)

processGmcp

byte[] processGmcp(Session session,
                   java.lang.String data,
                   java.util.Map<java.lang.String,java.lang.Double> supportables)

Main entry point to handle GMCP commands from the user

Parameters:

session - the session of the mob to report to

data - the command sent by the user

supportables - map of supported GMCP features

Returns:

null, or bytes to send to the user

See Also:

pingGmcp(Session, Map, Map), invokeRoomChangeGmcp(Session, Map, Map), ProtocolLibrary.GMCPCommand

pingGmcp

byte[] pingGmcp(Session session,
                java.util.Map<java.lang.String,java.lang.Long> reporteds,
                java.util.Map<java.lang.String,java.lang.Double> supportables)

Called every second from each player session to deal with periodic GMCP reports.

Parameters:

session - the session of the mob to report to

reporteds - the 'subscriptions' of the given session

supportables - map of supported GMCP features

Returns:

null, or bytes to send to the user

See Also:

processGmcp(Session, String, Map), invokeRoomChangeGmcp(Session, Map, Map), ProtocolLibrary.GMCPCommand

invokeRoomChangeGmcp

byte[] invokeRoomChangeGmcp(Session session,
                            java.util.Map<java.lang.String,java.lang.Long> reporteds,
                            java.util.Map<java.lang.String,java.lang.Double> supportables)

GMCP appears to support getting a report from the protocol when entering a new room. This method is called to handle those reports.

Parameters:

session - the session of the mob to report to

reporteds - the 'subscriptions' of the given session

supportables - map of supported GMCP features

Returns:

null, or bytes to send to the user

See Also:

processGmcp(Session, String, Map), pingGmcp(Session, Map, Map), ProtocolLibrary.GMCPCommand