bluefire/session/Session.coffee

Lightweight tcp framework

###

@method #beforeSerialize
  Called before packet send
  @param [String] name of the packet
  @param [Object] data to be sent

@method #beforeSend
  Called before sending packet (after #beforeSerialize)
  @param [String] name of the packet
  @param [Object] non-serialized data
  @param [Byte Array] serialized data

@method #afterSend
  Called after sending packet (after #beforeSend)
  @param [String] name of the packet
  @param [Byte Array] serialized data

@method #onConnect
  Called when session connected

@method #onDisconnect
  Called when session disconnected
###
module.exports = class Session

  constructor: () ->
    @socket = null
    @tasks = { }
    @protocol = { }

  initialize: (socket, @parser) =>
    @socket = socket

    socket.session = @
    socket.getSession = () =>
      return @session

  ### socket connection manipulation ###
  getSocket: () =>
    return @socket

  ###
    Closes the socket so no more IO will happen.
    This will first end socket, and then destroy it.
  ###
  close: () =>
    @end()
    @socket.destroy() # this will also call close event

  ###
    Ends the socket, telling other side that no more info will be sent
    from socket
  ###
  end: (data, encoding) =>
    @socket.end(data, encoding)

  ### Serialization and parsing ###

  ###
  @private
  ###
  beforeSerialize: (packetName, data) ->

  ###
  @private
  ###
  beforeSend: (packetName, data, serialized) ->

  ###
  @private
  ###
  afterSend: (packetName, data) ->

  send: (packetName, data = { }, callback) =>
    @beforeSerialize packetName, data if @beforeSerialize?

    @parser.serialize(data, packetName).then (serialized) =>
      @beforeSend packetName, data, serialized if @beforeSend? # send non serialized and serialized data

      Injector.getService("$protocol").send(serialized, @)
      #@write(serialized)

      @afterSend packetName, data if @afterSend?
      callback() if callback?

  write: (data) =>
    @socket.write data

  addTask: (name) =>
    if @tasks[name]?
      @removeTask(name)

    @tasks[name] = Injector.getService("$taskmgr").perform(name, @)

  removeTask: (name) =>
    if @tasks[name]?
      @tasks[name].stop()

    delete @tasks[name]

  removeAllTasks: () =>
    for name, task of @tasks
      @removeTask(name)

  onConnect: () ->

  onDisconnect: () ->