標籤：openrtmfpcumulus
本頁中列出Server application中對象和事件的詳細資料。要瞭解如何建立一個服務應用，以及想知道它的工作流程，請閱讀Server application。
對象
通用概念
屬性
如下屬性操作有效
value = object.property
方法
方法按照如下方式調用：
results = object:method(arguments)
事件
某些對象含事件，系統調用只，僅需在函數中重寫該事件名稱即可。
function object:onManage() self:writeAMFMessage("push","test")end
pairs
對於某些含map類型值的對象，可以用pairs方法迭代，如下：
for name,value in mapObject:pairs() do print(name,value)end
ipairs
如果是arry類型，則用ipairs方法迭代
for index,value in arrayObject:ipairs() do print(index,value)end
Cumulus
cumulus是全域對象，提供主Cumulus的所有元素，許可在指令檔的任何地方調用。
屬性
- clients (read-only)：唯讀。所有正在串連的用戶端，具體查看後面的clients對象。
- configs,：返回LUA的table類型資料，包含Cumulus的配置資訊，即CumulusServer.ini檔案中的資訊以及其它可用參數（application.path,application.baseName,等等，通過迭代這個table能夠得到其內容）。在Server application的Global configurations中有一個例子。
- epochTime (read-only)：唯讀。 返回時間(從Unix的紀元事件開始，1970年1月1日0時0分0秒開始，精確到百萬分之一秒）。
- groups (read-only)：唯讀。返回存在的分組，查看後面的groups對象。
- pulications (read-only)：唯讀。（應該是publication，原文有誤）有效服務發布資訊，查看隨後的publications。
- servers (read-only)：唯讀。CumulusServer執行個體化正在已連線的服務，查看servers對象。
- publicAddress (read-only)：唯讀。 所設定的公網伺服器位址。
方法
- absolutePath(path)：.第一個參數為應用的path,並返回其目錄的絕對路徑。這有助於你將伺服器應用的代碼分別寫到多個LUA檔案中（參閱Server application中的LUA extensions and files inclusion ）。
- addToBlacklist(...)：添加IP黑名單
- removeFromBlacklist(...)：從黑名單中移除ip
- createTCPClient()：TCP用戶端，參閱Server Application, Sockets
- createTCPServer()：TCP服務，參閱Server Application, Sockets
- createUDPSocket([allowBroadcast])：返回UDP。 通過這個socket能調用布爾型變數allowBroadcast廣播資料。
- publish(name)：根據name發行伺服器的publication，如果成功，返回Publication對象，否則返回nil。如果遇到同樣name的publication也會失敗。閱讀Publication對象的有關說明，瞭解更多如何通過publication推送音頻、視頻和資料包。
- fromAMF(data)：將AMF資料轉化為參數中的相互關聯類型。
- toAMF(...)：將LUA類型轉化為AMF格式。
- toAMF0(...)：已有同樣的方法，但是優先轉化為AMF0格式（如果有可能）
- md5(...)：輸入值做為變數，返回MD5值。
- sha256(...)：輸入值做為變數，返回sha256值。
- sendMail(sender,subject,content,...)：sender為寄件者，向收件者發送郵件，收件者地址為後面的多參數欄位。返回的郵件對象僅包括onSent(error)，記錄這發送資訊。參閱Server Application, Sockets。
- split(expression,separator[,option])：LUA沒有分割操作，此函數填補了該遺憾。以separator來分割expression.返回字串，option=1：忽略返回值的空格；option=2:刪除開頭和結尾的空格；option=3:兩者在同一時間。
註：OpenRTMFP官方網址.原文在該代碼的wiki中。更多關於本文的翻譯結果，請閱讀:https://github.com/qiwsir/Cumulus
