CFIDE.adminapi.websocket
Component websocket (websocket)


Manages websocket settings.


hierarchy: WEB-INF.cftags.component
      CFIDE.adminapi.base
            CFIDE.adminapi.websocket
path: /opt/coldfusion/cfusion/wwwroot/CFIDE/adminapi/websocket.cfc
serializable: Yes
properties:
final: false
abstract: false
methods: getProperty, setProperty
inherited methods: dump, getEdition, getInstallType, isAdminUser, logaudit
* - private method

getProperty
public any getProperty ( required propertyName )

Returns the value of a WebSocket property setting.

Output: suppressed
Parameters:
   propertyName: any, required, propertyName -

Valid Properties are:
  • EnableWebSocketServer
  • EnableProxyPort
  • EnableNormalPortListener
  • Port
  • MaxDataSize
  • StartFlashPolicyServer
  • EnableWebSocketCluster
  • MulticastPort
  • EnableSecureWebSocket
  • SSLPort
  • KeyStorePath
  • KeyStorePassword


setProperty
public any setProperty ( required propertyName, required propertyValue )

Sets the value of a WebSocket property setting.

Output: suppressed
Parameters:
   propertyName: any, required, propertyName -

Valid Properties are:
  • EnableWebSocketServer
  • EnableProxyPort
  • EnableNormalPortListener
  • Port
  • MaxDataSize
  • StartFlashPolicyServer
  • EnableWebSocketCluster
  • MulticastPort
  • EnableSecureWebSocket
  • SSLPort
  • KeyStorePath
  • KeyStorePassword

   propertyValue: any, required, propertyValue - Value to set for the specified property.