Message

Namespace: fszmq

Contains methods for working with Message instances

Functions and values

Function or value	Description
`( \|<< ) message socket` Signature: message:Message -> socket:Socket -> unit	Operator equivalent to `Message.recv` CompiledName: `op_BarLessLess`
`( +>> ) message socket` Signature: message:Socket -> socket:Message -> unit	Operator equivalent to `Message.sendMore` (with arguments reversed) CompiledName: `op_PlusGreaterGreater`
`( <<- ) socket message` Signature: socket:Socket -> message:Message -> unit	Operator equivalent to `Message.send` CompiledName: `op_LessLessMinus`
`( <<+ ) socket message` Signature: socket:Message -> message:Socket -> unit	Operator equivalent to `Message.sendMore` CompiledName: `op_LessLessPlus`
`( ->> ) message socket` Signature: message:Message -> socket:Socket -> unit	Operator equivalent to `Message.send` (with arguments reversed) CompiledName: `op_MinusGreaterGreater`
`( >>\| ) socket message` Signature: socket:Socket -> message:Message -> unit	Operator equivalent to `Message.recv` (with arguments reversed) CompiledName: `op_GreaterGreaterBar`
`clone source` Signature: source:Message -> Message	Makes a new instance of the Message type, with an independent copy of the source content. CompiledName: `Clone`
`configure message options` Signature: message:Message -> options:seq<int * int> -> unit	Sets the given block of option values for the given Message CompiledName: `Configure`
`copy source target` Signature: source:Message -> target:Message -> unit	Copies the content from one message to another message. Avoid modifying message content after a message has been copied, as this can result in undefined behavior. CompiledName: `Copy`
`data message` Signature: message:Message -> byte []	Returns the content of the given Message CompiledName: `Data`
`getOption message messageOption` Signature: message:Message -> messageOption:int -> int	Gets the value of the given option for the given Message CompiledName: `GetOption`
`hasMore message` Signature: message:Message -> bool	Returns true if the given message is a frame in a multi-part message and more frames are available CompiledName: `HasMore`
`isMatch left right` Signature: left:Message -> right:Message -> bool	Tests if two `Message` instances have the same size and data CompiledName: `IsMatch`
`move source target` Signature: source:Message -> target:Message -> unit	Moves the content from one message to another message. No actual copying of message content is performed, target is simply updated to reference the new content. source becomes an empty message after calling `Message.move()`. The original content of target, if any, shall be released. To preseve the content of source, see `Message.copy()`. CompiledName: `Move`
`recv message socket` Signature: message:Message -> socket:Socket -> unit	Updates the given `Message` instance with the next available message from a socket; If no message is received before RCVTIMEO expires, throws a TimeoutException CompiledName: `Recv`
`send message socket` Signature: message:Message -> socket:Socket -> unit	Sends a message, indicating no more messages will follow CompiledName: `Send`
`sendMore message socket` Signature: message:Message -> socket:Socket -> unit	Sends a message, indicating more messages will follow CompiledName: `SendMore`
`setOption message (messageOption, value)` Signature: message:Message -> (messageOption:int * value:int) -> unit	Sets the given option value for the given Message CompiledName: `SetOption`
`size message` Signature: message:Message -> int	Returns the size (in bytes) of the given Message CompiledName: `Size`
`tryGetMetadata message name` Signature: message:Message -> name:string -> string option	For a given message, returns the metadata associated with the given name as an `Option<string>` where `None` indicates no metadata is present CompiledName: `TryGetMetadata`
`tryLoadMetadata message name value` Signature: message:Message -> name:string -> value:byref<string> -> bool	For a given message, extracts the metadata associated with the given name, returning false if no metadata is present (for the given name) This function is named TryGetMetadata in compiled assemblies. If you are accessing the function from a language other than F#, or through reflection, use this name. CompiledName: `TryGetMetadata`
`tryRecv message socket flags` Signature: message:Message -> socket:Socket -> flags:int -> bool	Updates the given `Message` instance with the next available message from a socket, returning true (or false) if the recv was successful (or should be re-tried) CompiledName: `TryRecv`
`trySend message socket flags` Signature: message:Message -> socket:Socket -> flags:int -> bool	Sends a message, with the given flags, returning true (or false) if the send was successful (or should be re-tried) CompiledName: `TrySend`