Class WebMessageSystem
Client for glued contract Azos.Sky.Contracts.IWebMessageSystem server.
Each contract method has synchronous and asynchronous versions, the later denoted by 'Async_' prefix.
May inject client-level inspectors here like so:
client.MsgInspectors.Register( new YOUR_CLIENT_INSPECTOR_TYPE());
Inheritance
System.Object
WebMessageSystem
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Assembly: Azos.Sky.dll
Syntax
public class WebMessageSystem : ClientEndPoint, IWebMessageSystemClient, ISkyServiceClient, IDisposable, IWebMessageSystem, ISkyService
Constructors
WebMessageSystem(IGlue, Node, Binding)
Declaration
public WebMessageSystem(IGlue glue, Node node, Binding binding = null)
Parameters
WebMessageSystem(IGlue, String, Binding)
Declaration
public WebMessageSystem(IGlue glue, string node, Binding binding = null)
Parameters
| Type |
Name |
Description |
| IGlue |
glue |
|
| System.String |
node |
|
| Binding |
binding |
|
Properties
Contract
Declaration
public override Type Contract { get; }
Property Value
| Type |
Description |
| System.Type |
|
Overrides
Methods
Async_FetchMailboxMessage(MailboxMsgID)
Asynchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.FetchMailboxMessage'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning no exception or WrappedExceptionData instance.
CallSlot is returned that can be queried for CallStatus, ResponseMsg and result.
Declaration
public CallSlot Async_FetchMailboxMessage(MailboxMsgID mid)
Parameters
Returns
Async_FetchMailboxMessageAttachment(MailboxMsgID, Int32)
Asynchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.FetchMailboxMessageAttachment'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning no exception or WrappedExceptionData instance.
CallSlot is returned that can be queried for CallStatus, ResponseMsg and result.
Declaration
public CallSlot Async_FetchMailboxMessageAttachment(MailboxMsgID mid, int attachmentIndex)
Parameters
| Type |
Name |
Description |
| MailboxMsgID |
mid |
|
| System.Int32 |
attachmentIndex |
|
Returns
Async_GetMailboxInfo(MailboxID)
Asynchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.GetMailboxInfo'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning no exception or WrappedExceptionData instance.
CallSlot is returned that can be queried for CallStatus, ResponseMsg and result.
Declaration
public CallSlot Async_GetMailboxInfo(MailboxID xid)
Parameters
Returns
Async_GetMailboxMessageCount(MailboxID, String)
Asynchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.GetMailboxMessageCount'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning no exception or WrappedExceptionData instance.
CallSlot is returned that can be queried for CallStatus, ResponseMsg and result.
Declaration
public CallSlot Async_GetMailboxMessageCount(MailboxID xid, string query)
Parameters
| Type |
Name |
Description |
| MailboxID |
xid |
|
| System.String |
query |
|
Returns
Asynchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.GetMailboxMessageHeaders'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning no exception or WrappedExceptionData instance.
CallSlot is returned that can be queried for CallStatus, ResponseMsg and result.
Declaration
public CallSlot Async_GetMailboxMessageHeaders(MailboxID xid, string query)
Parameters
| Type |
Name |
Description |
| MailboxID |
xid |
|
| System.String |
query |
|
Returns
Async_SendMessage(SkyWebMessage)
Asynchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.SendMessage'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning no exception or WrappedExceptionData instance.
CallSlot is returned that can be queried for CallStatus, ResponseMsg and result.
Declaration
public CallSlot Async_SendMessage(SkyWebMessage msg)
Parameters
Returns
Async_UpdateMailboxMessagePublication(MailboxMsgID, MsgPubStatus, String, String)
Asynchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.UpdateMailboxMessagePublication'.
This is a one-way call per contract specification, meaning - the server sends no acknowledgement of this call receipt and
there is no result that server could return back to the caller.
CallSlot is returned that can be queried for CallStatus, ResponseMsg.
Declaration
public CallSlot Async_UpdateMailboxMessagePublication(MailboxMsgID mid, MsgPubStatus status, string oper, string description)
Parameters
Returns
Async_UpdateMailboxMessagesStatus(IEnumerable<MailboxMsgID>, MsgStatus, String, String)
Asynchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.UpdateMailboxMessagesStatus'.
This is a one-way call per contract specification, meaning - the server sends no acknowledgement of this call receipt and
there is no result that server could return back to the caller.
CallSlot is returned that can be queried for CallStatus, ResponseMsg.
Declaration
public CallSlot Async_UpdateMailboxMessagesStatus(IEnumerable<MailboxMsgID> mids, MsgStatus status, string folders, string adornments)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.IEnumerable<MailboxMsgID> |
mids |
|
| MsgStatus |
status |
|
| System.String |
folders |
|
| System.String |
adornments |
|
Returns
Async_UpdateMailboxMessageStatus(MailboxMsgID, MsgStatus, String, String)
Asynchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.UpdateMailboxMessageStatus'.
This is a one-way call per contract specification, meaning - the server sends no acknowledgement of this call receipt and
there is no result that server could return back to the caller.
CallSlot is returned that can be queried for CallStatus, ResponseMsg.
Declaration
public CallSlot Async_UpdateMailboxMessageStatus(MailboxMsgID mid, MsgStatus status, string folders, string adornments)
Parameters
Returns
FetchMailboxMessage(MailboxMsgID)
Synchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.FetchMailboxMessage'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning '@Azos.@Sky.@WebMessaging.@SkyWebMessage' or WrappedExceptionData instance.
ClientCallException is thrown if the call could not be placed in the outgoing queue.
RemoteException is thrown if the server generated exception during method execution.
Declaration
public SkyWebMessage FetchMailboxMessage(MailboxMsgID mid)
Parameters
Returns
FetchMailboxMessageAttachment(MailboxMsgID, Int32)
Synchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.FetchMailboxMessageAttachment'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning '@Azos.@Web.@Messaging.@Message.@Attachment' or WrappedExceptionData instance.
ClientCallException is thrown if the call could not be placed in the outgoing queue.
RemoteException is thrown if the server generated exception during method execution.
Declaration
public Message.Attachment FetchMailboxMessageAttachment(MailboxMsgID mid, int attachmentIndex)
Parameters
| Type |
Name |
Description |
| MailboxMsgID |
mid |
|
| System.Int32 |
attachmentIndex |
|
Returns
GetMailboxInfo(MailboxID)
Synchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.GetMailboxInfo'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning '@Azos.@Sky.@WebMessaging.@MailboxInfo' or WrappedExceptionData instance.
ClientCallException is thrown if the call could not be placed in the outgoing queue.
RemoteException is thrown if the server generated exception during method execution.
Declaration
public MailboxInfo GetMailboxInfo(MailboxID xid)
Parameters
Returns
GetMailboxMessageCount(MailboxID, String)
Synchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.GetMailboxMessageCount'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning '@Azos.@Sky.@Contracts.@MessageHeaders' or WrappedExceptionData instance.
ClientCallException is thrown if the call could not be placed in the outgoing queue.
RemoteException is thrown if the server generated exception during method execution.
Declaration
public int GetMailboxMessageCount(MailboxID xid, string query)
Parameters
| Type |
Name |
Description |
| MailboxID |
xid |
|
| System.String |
query |
|
Returns
| Type |
Description |
| System.Int32 |
|
Synchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.GetMailboxMessageHeaders'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning '@Azos.@Sky.@Contracts.@MessageHeaders' or WrappedExceptionData instance.
ClientCallException is thrown if the call could not be placed in the outgoing queue.
RemoteException is thrown if the server generated exception during method execution.
Declaration
public MessageHeaders GetMailboxMessageHeaders(MailboxID xid, string query)
Parameters
| Type |
Name |
Description |
| MailboxID |
xid |
|
| System.String |
query |
|
Returns
SendMessage(SkyWebMessage)
Synchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.SendMessage'.
This is a two-way call per contract specification, meaning - the server sends the result back either
returning '@Azos.@Sky.@Contracts.@MsgSendInfo[]' or WrappedExceptionData instance.
ClientCallException is thrown if the call could not be placed in the outgoing queue.
RemoteException is thrown if the server generated exception during method execution.
Declaration
public MsgSendInfo[] SendMessage(SkyWebMessage msg)
Parameters
Returns
UpdateMailboxMessagePublication(MailboxMsgID, MsgPubStatus, String, String)
Synchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.UpdateMailboxMessagePublication'.
This is a one-way call per contract specification, meaning - the server sends no acknowledgement of this call receipt and
there is no result that server could return back to the caller.
ClientCallException is thrown if the call could not be placed in the outgoing queue.
Declaration
public void UpdateMailboxMessagePublication(MailboxMsgID mid, MsgPubStatus status, string oper, string description)
Parameters
UpdateMailboxMessagesStatus(IEnumerable<MailboxMsgID>, MsgStatus, String, String)
Synchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.UpdateMailboxMessagesStatus'.
This is a one-way call per contract specification, meaning - the server sends no acknowledgement of this call receipt and
there is no result that server could return back to the caller.
ClientCallException is thrown if the call could not be placed in the outgoing queue.
Declaration
public void UpdateMailboxMessagesStatus(IEnumerable<MailboxMsgID> mids, MsgStatus status, string folders, string adornments)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.IEnumerable<MailboxMsgID> |
mids |
|
| MsgStatus |
status |
|
| System.String |
folders |
|
| System.String |
adornments |
|
UpdateMailboxMessageStatus(MailboxMsgID, MsgStatus, String, String)
Synchronous invoker for 'Azos.Sky.Contracts.IWebMessageSystem.UpdateMailboxMessageStatus'.
This is a one-way call per contract specification, meaning - the server sends no acknowledgement of this call receipt and
there is no result that server could return back to the caller.
ClientCallException is thrown if the call could not be placed in the outgoing queue.
Declaration
public void UpdateMailboxMessageStatus(MailboxMsgID mid, MsgStatus status, string folders, string adornments)
Parameters
Implements
System.IDisposable
Extension Methods