From 87bac1a0d3063c2760cdba68d77c1fab78652476 Mon Sep 17 00:00:00 2001 From: Chris Boden Date: Thu, 12 Jul 2012 15:21:54 -0400 Subject: [PATCH] API docs --- Version/RFC6455/Frame.php | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Version/RFC6455/Frame.php b/Version/RFC6455/Frame.php index f8c0353..5ff8330 100644 --- a/Version/RFC6455/Frame.php +++ b/Version/RFC6455/Frame.php @@ -203,6 +203,7 @@ class Frame implements FrameInterface { } /** + * Create a 4 byte masking key * @return string */ public function generateMaskingKey() { @@ -270,6 +271,13 @@ class Frame implements FrameInterface { return $this; } + /** + * Apply a mask to a string or the payload of the instance + * @param string The 4 character masking key to be applied + * @param string|null A string to mask or null to use the payload + * @throws UnderflowException If using the payload but enough hasn't been buffered + * @return string The masked string + */ protected function applyMask($maskingKey, $payload = null) { if (null === $payload) { if (!$this->isCoalesced()) {