Platforms to show: All Mac Windows Linux Cross-Platform
Back to WebSocketHelperMBS module.
WebSocketHelperMBS.AddHeader(data as Memoryblock, opCode as Integer = 7) as Memoryblock
Function:
Adds header to a frame.
Notes: Depending on the length of the frame we add two to ten bytes in front with the opcode included and the length information.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Network | MBS Network Plugin | 12.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Depending on the length of the frame we add two to ten bytes in front with the opcode included and the length information.
See also:
WebSocketHelperMBS.AddHeader(data as string, opCode as Integer = 7) as string
Function:
Adds header to a frame.
Notes: Depending on the length of the frame we add two to ten bytes in front with the opcode included and the length information.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Network | MBS Network Plugin | 12.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Depending on the length of the frame we add two to ten bytes in front with the opcode included and the length information.
See also:
WebSocketHelperMBS.FrameMasked(data as Memoryblock) as boolean
Function:
Whether the frame is masked or not.
Notes: Returns true if the first bit of the first byte is set.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Network | MBS Network Plugin | 12.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns true if the first bit of the first byte is set.
See also:
WebSocketHelperMBS.FrameMasked(data as string) as boolean
Function:
Whether the frame is masked or not.
Notes: Returns true if the first bit of the first byte is set.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Network | MBS Network Plugin | 12.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes: Returns true if the first bit of the first byte is set.
See also:
WebSocketHelperMBS.Unmask(data as Memoryblock) as Memoryblock
Function:
Unmasks a data packet.
Notes:
Does the reverse of AddHeader.
The string returned has no encoding defined.
For a text frame, you should use DefineEncoding with UTF-8.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Network | MBS Network Plugin | 12.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Does the reverse of AddHeader.
The string returned has no encoding defined.
For a text frame, you should use DefineEncoding with UTF-8.
See also:
WebSocketHelperMBS.Unmask(data as Memoryblock, byref Offset as Integer, byref Length as Integer, byref TotalLength as Integer) as Memoryblock
Function:
Unmasks a data packet.
Notes:
Does the reverse of AddHeader.
The string returned has no encoding defined.
For a text frame, you should use DefineEncoding with UTF-8.
This method also sets Offset, Length and TotalLength parameters.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Network | MBS Network Plugin | 14.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Does the reverse of AddHeader.
The string returned has no encoding defined.
For a text frame, you should use DefineEncoding with UTF-8.
This method also sets Offset, Length and TotalLength parameters.
See also:
WebSocketHelperMBS.Unmask(data as string) as string
Function:
Unmasks a data packet.
Notes:
Does the reverse of AddHeader.
The string returned has no encoding defined.
For a text frame, you should use DefineEncoding with UTF-8.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Network | MBS Network Plugin | 12.5 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Does the reverse of AddHeader.
The string returned has no encoding defined.
For a text frame, you should use DefineEncoding with UTF-8.
See also:
WebSocketHelperMBS.Unmask(data as string, byref Offset as Integer, byref Length as Integer, byref TotalLength as Integer) as string
Function:
Unmasks a data packet.
Notes:
Does the reverse of AddHeader.
The string returned has no encoding defined.
For a text frame, you should use DefineEncoding with UTF-8.
This method also sets Offset, Length and TotalLength parameters.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | Network | MBS Network Plugin | 14.1 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
Notes:
Does the reverse of AddHeader.
The string returned has no encoding defined.
For a text frame, you should use DefineEncoding with UTF-8.
This method also sets Offset, Length and TotalLength parameters.
See also:
The items on this page are in the following plugins: MBS Network Plugin.