TeensyMud - 'A ruby mud server.'

Browse repository
back

filter.rb

#
# file:: filter.rb
# author:: Jon A. Lambert
# version:: 2.8.0
# date:: 01/19/2006
#
# This source code copyright (C) 2005, 2006 by Jon A. Lambert
# All rights reserved.
#
# Released under the terms of the TeensyMUD Public License
# See LICENSE file for additional information.
#


# The Filter class is an abstract class defining the minimal methods
# needed to filter data.
#
# A Filter can keep state and partial data
class Filter

# Construct filter
#
# [+pstack+] The ProtocolStack associated with this filter
def initialize(pstack)
@pstack = pstack
end

# Run any post-contruction initialization
# [+args+] Optional initial options
def init(args=nil)
true
end

# The filter_in method filters input data
# [+str+] The string to be processed
# [+return+] The filtered data
def filter_in(str)
str
end

# The filter_out method filters output data
# [+str+] The string to be processed
# [+return+] The filtered data
def filter_out(str)
str
end

end