com.planet_ink.coffee_mud.Libraries.interfaces
Interface ChannelsLibrary

All Superinterfaces:

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

All Known Implementing Classes:

CMChannels

public interface ChannelsLibrary
extends CMLibrary

Nested Class Summary

static class

ChannelsLibrary.ChannelFlag

Field Summary

static int

QUEUE_SIZE

Method Summary

void	channelQueUp(int i, CMMsg msg)
boolean	channelTo(Session ses, boolean areareq, int channelInt, CMMsg msg, MOB sender)
java.util.List<Session>	clearInvalidSnoopers(Session mySession, int channelCode)
int	getChannelCodeNumber(java.lang.String channelName)
java.util.HashSet<ChannelsLibrary.ChannelFlag>	getChannelFlags(int i)
int	getChannelIndex(java.lang.String channelName)
java.lang.String	getChannelMask(int i)
java.lang.String	getChannelName(int i)
java.lang.String	getChannelName(java.lang.String channelName)
java.lang.String[]	getChannelNames()
java.util.List<CMMsg>	getChannelQue(int i)
java.lang.String	getExtraChannelDesc(java.lang.String channelName)
java.util.List<java.lang.String>	getFlaggedChannelNames(ChannelsLibrary.ChannelFlag flag)
int	getNumChannels()
java.lang.String[][]	iChannelsArray()
java.lang.String[][]	imc2ChannelsArray()
int	loadChannels(java.lang.String list, java.lang.String ilist, java.lang.String imc2list)
boolean	mayReadThisChannel(MOB sender, boolean areaReq, MOB M, int i)
boolean	mayReadThisChannel(MOB sender, boolean areaReq, MOB M, int i, boolean offlineOK)
boolean	mayReadThisChannel(MOB sender, boolean areaReq, Session ses, int i)
boolean	mayReadThisChannel(MOB M, int i, boolean zapCheckOnly)
java.lang.String	parseOutFlags(java.lang.String mask, java.util.HashSet<ChannelsLibrary.ChannelFlag> flags)
void	reallyChannel(MOB mob, java.lang.String channelName, java.lang.String message, boolean systemMsg)
void	restoreInvalidSnoopers(Session mySession, java.util.List<Session> invalid)

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

activate, getSupportThread, propertiesLoaded, shutdown

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

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

QUEUE_SIZE

static final int QUEUE_SIZE

See Also:

Constant Field Values

Method Detail

getNumChannels

int getNumChannels()

getChannelMask

java.lang.String getChannelMask(int i)

getChannelFlags

java.util.HashSet<ChannelsLibrary.ChannelFlag> getChannelFlags(int i)

getChannelName

java.lang.String getChannelName(int i)

getChannelQue

java.util.List<CMMsg> getChannelQue(int i)

mayReadThisChannel

boolean mayReadThisChannel(MOB sender,
                           boolean areaReq,
                           MOB M,
                           int i)

mayReadThisChannel

boolean mayReadThisChannel(MOB sender,
                           boolean areaReq,
                           MOB M,
                           int i,
                           boolean offlineOK)

mayReadThisChannel

boolean mayReadThisChannel(MOB sender,
                           boolean areaReq,
                           Session ses,
                           int i)

mayReadThisChannel

boolean mayReadThisChannel(MOB M,
                           int i,
                           boolean zapCheckOnly)

channelQueUp

void channelQueUp(int i,
                  CMMsg msg)

getChannelIndex

int getChannelIndex(java.lang.String channelName)

getChannelCodeNumber

int getChannelCodeNumber(java.lang.String channelName)

getChannelName

java.lang.String getChannelName(java.lang.String channelName)

getFlaggedChannelNames

java.util.List<java.lang.String> getFlaggedChannelNames(ChannelsLibrary.ChannelFlag flag)

getExtraChannelDesc

java.lang.String getExtraChannelDesc(java.lang.String channelName)

imc2ChannelsArray

java.lang.String[][] imc2ChannelsArray()

iChannelsArray

java.lang.String[][] iChannelsArray()

getChannelNames

java.lang.String[] getChannelNames()

clearInvalidSnoopers

java.util.List<Session> clearInvalidSnoopers(Session mySession,
                                             int channelCode)

restoreInvalidSnoopers

void restoreInvalidSnoopers(Session mySession,
                            java.util.List<Session> invalid)

parseOutFlags

java.lang.String parseOutFlags(java.lang.String mask,
                               java.util.HashSet<ChannelsLibrary.ChannelFlag> flags)

loadChannels

int loadChannels(java.lang.String list,
                 java.lang.String ilist,
                 java.lang.String imc2list)

channelTo

boolean channelTo(Session ses,
                  boolean areareq,
                  int channelInt,
                  CMMsg msg,
                  MOB sender)

reallyChannel

void reallyChannel(MOB mob,
                   java.lang.String channelName,
                   java.lang.String message,
                   boolean systemMsg)