AsterNet Class Library (Sandcastle documentation)

| ManagerConnection Class

Default implemention of the ManagerConnection interface.
Inheritance Hierarchy
System
Object
AsterNET.Manager
ManagerConnection

Namespace: AsterNET.Manager
Assembly: AsterNET (in AsterNET.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C#
VB
C++
F#
Copy

    public class ManagerConnection

    Public Class ManagerConnection

    public ref class ManagerConnection

    type ManagerConnection =  class end

The ManagerConnection type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| ManagerConnection | Creates a new instance.
| ManagerConnection(String, Int32, String, String) | Creates a new instance with the given connection parameters.
| ManagerConnection(String, Int32, String, String, Encoding) | Creates a new instance with the given connection parameters.

Top
Methods

| Name | Description
--- | --- | ---
| BuildAction(ManagerAction) |
| BuildAction(ManagerAction, String) |
| connect |
| determineVersion |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.)
| GetProtocolIdentifier |
| GetType | Gets the Type of the current instance. (Inherited from Object.)
| IsConnected | Returns true if there is a socket connection to the asterisk server, false otherwise.
| Login | Logs in to the Asterisk manager using asterisk's MD5 based challenge/response protocol. The login is delayed until the protocol identifier has been received by the reader.
| Login(Int32) | Log in to the Asterisk manager using asterisk's MD5 based challenge/response protocol. The login is delayed until the protocol identifier has been received by the reader.
| Logoff | Sends a LogoffAction and disconnects from the server.
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.)
| RegisterUserEventClass | Register User Event Class
| SendAction(ManagerAction) | Send Action with default timeout.
| SendAction(ManagerAction, ResponseHandler) |
| SendAction(ManagerAction, Int32) | Send action ans with timeout (milliseconds)
| SendEventGeneratingAction(ManagerActionEvent) |
| SendEventGeneratingAction(ManagerActionEvent, Int32) |
| ToString | Returns a string that represents the current object. (Inherited from Object.)

Top
Fields

| Name | Description
--- | --- | ---
| UseASyncEvents | Allows you to specifiy how events are fired. If false (default) then events will be fired in order. Otherwise events will be fired as they arrive and control logic in your application will need to handle synchronization.
| VAR_DELIMITER |

Top
Properties

| Name | Description
--- | --- | ---
| AsteriskVersion |
| DefaultEventTimeout | Sets the time in milliseconds the synchronous method will wait for a response and the last response event before throwing a TimeoutException. Default is 5000.
| DefaultResponseTimeout | Sets the time in milliseconds the synchronous method will wait for a response before throwing a TimeoutException. Default is 2000.
| FireAllEvents | If this property set to true then ManagerConnection send all unassigned events to UnhandledEvent handler, if set to false then all unassgned events lost and send only UnhandledEvent. Default: false
| Hostname | Sets the hostname of the asterisk server to connect to. Default is localhost.
| KeepAlive | Should we attempt to reconnect when the connection is lost? This is set to true after successful login and to false after logoff or after an authentication failure when keepAliveAfterAuthenticationFailure is false.
| KeepAliveAfterAuthenticationFailure | Set to true to try reconnecting to ther asterisk serve even if the reconnection attempt threw an AuthenticationFailedException. Default is false.
| Password | Sets the password to use to connect to the asterisk server. This is the password specified in asterisk's manager.conf file.
| PingInterval | Timeout from Ping to Pong. If no Pong received send Disconnect event. Set to zero to disable.
| Port | Sets the port to use to connect to the asterisk server. This is the port specified in asterisk's manager.conf file. Default is 5038.
| ReconnectIntervalFast | Default Fast Reconnect interval in milliseconds.
| ReconnectIntervalMax | Default Slow Reconnect interval in milliseconds.
| ReconnectRetryFast | Default Fast Reconnect retry counter.
| ReconnectRetryMax | Default Maximum Reconnect retry counter.
| SleepTime | Sets the time in milliseconds the synchronous methods SendAction(Action.ManagerAction) and SendAction(Action.ManagerAction, long) will sleep between two checks for the arrival of a response. This value should be rather small. The sleepTime attribute is also used when checking for the protocol identifer. Default is 50.
| SocketEncoding | Socket Encoding - default ASCII
| Username | Sets the username to use to connect to the asterisk server. This is the username specified in asterisk's manager.conf file.
| Version |

Top
Events

| Name | Description
--- | --- | ---
| AgentCallbackLogin | An AgentCallbackLogin is triggered when an agent is successfully logged in.
| AgentCallbackLogoff | An AgentCallbackLogoff is triggered when an agent that previously logged in is logged of.
| AgentCalled | An AgentCalled is triggered when an agent is ring. To enable AgentCalled you have to set eventwhencalled = yes in queues.conf.
| AgentComplete | An AgentCompleteEvent is triggered when at the end of a call if the caller was connected to an agent.
| AgentConnect | An AgentConnectEvent is triggered when a caller is connected to an agent.
| AgentDump | An AgentDumpEvent is triggered when an agent dumps the caller while listening to the queue announcement.
| AgentLogin | An AgentLoginEvent is triggered when an agent is successfully logged in using AgentLogin.
| AgentLogoff | An AgentCallbackLogoffEvent is triggered when an agent that previously logged in using AgentLogin is logged of.
| Agents | An AgentsEvent is triggered for each agent in response to an AgentsAction.
| AgentsComplete | An AgentsCompleteEvent is triggered after the state of all agents has been reported in response to an AgentsAction.
| AGIExec | AgiExec is execute
| Alarm | An AlarmEvent is triggered when a Zap channel enters or changes alarm state.
| AlarmClear | An AlarmEvent is triggered when a Zap channel leaves alarm state.
| AttendedTransfer |
| BlindTransfer |
| Bridge |
| BridgeCreate |
| BridgeDestroy |
| BridgeEnter |
| BridgeLeave |
| Cdr | A CdrEvent is triggered when a call detail record is generated, usually at the end of a call.
| ConfbridgeEnd | This event is sent when the last user leaves a conference and it is torn down.
| ConfbridgeJoin | This event is sent when a user joins a conference - either one already in progress or as the first user to join a newly instantiated bridge.
| ConfbridgeLeave | This event is sent when a user leaves a conference.
| ConfbridgeStart | This event is sent when the first user requests a conference and it is instantiated
| ConfbridgeTalking | This event is sent when the conference detects that a user has either begin or stopped talking.
| ConnectionState | A ConnectionState is triggered after Connect/Disconnect/Reload/Shutdown events.
| DBGetResponse |
| Dial | A Dial is triggered whenever a phone attempts to dial someone.
| DialBegin | Raised when a dial action has started.
| DialEnd | Raised when a dial action has completed.
| DNDState | A DNDStateEvent is triggered by the Zap channel driver when a channel enters or leaves DND (do not disturb) state.
| DTMF |
| ExtensionStatus | An ExtensionStatus is triggered when the state of an extension changes.
| FailedACL |
| Hangup | A Hangup is triggered when a channel is hung up.
| Hold | A Hold is triggered by the SIP channel driver when a channel is put on hold.
| HoldedCall | A HoldedCall is triggered when a channel is put on hold.
| Join | A Join is triggered when a channel joines a queue.
| Leave | A Leave is triggered when a channel leaves a queue.
| Link | A Link is triggered when two voice channels are linked together and voice data exchange commences. Several Link events may be seen for a single call. This can occur when Asterisk fails to setup a native bridge for the call.This is when Asterisk must sit between two telephones and perform CODEC conversion on their behalf.
| LogChannel | A LogChannel is triggered when logging is turned on or off.
| MeetMeJoin | A MeetMeJoin is triggered if a channel joins a meet me conference.
| MeetMeLeave | A MeetMeLeave is triggered if a channel leaves a meet me conference.
| MeetMeTalking | A MeetMeTalkingEvent is triggered when a user starts talking in a meet me conference. To enable talker detection you must pass the option 'T' to the MeetMe application.
| MessageWaiting | A MessageWaiting is triggered when someone leaves voicemail.
| NewCallerId | A NewCallerId is triggered when the caller id of a channel changes.
| NewChannel | A NewChannel is triggered when a new channel is created.
| NewExten | A NewExten is triggered when a channel is connected to a new extension.
| NewState | A NewState is triggered when the state of a channel has changed.
| OriginateResponse | An OriginateResponse is triggered when the execution of an Originate.
| ParkedCall | A ParkedCall is triggered when a channel is parked (in this case no action id is set) and in response to a ParkedCallsAction.
| ParkedCallGiveUp | A ParkedCallGiveUp is triggered when a channel that has been parked is hung up.
| ParkedCallsComplete | A ParkedCallsComplete is triggered after all parked calls have been reported in response to a ParkedCallsAction.
| ParkedCallTimeOut | A ParkedCallTimeOut is triggered when call parking times out for a given channel.
| PeerEntry | A PeerEntry is triggered in response to a SIPPeersAction or SIPShowPeerAction and contains information about a peer.
| PeerlistComplete | A PeerlistComplete is triggered after the details of all peers has been reported in response to an SIPPeersAction or SIPShowPeerAction.
| PeerStatus | A PeerStatus is triggered when a SIP or IAX client attempts to registrer at this asterisk server.
| QueueCallerAbandon | A QueueEntryEvent is triggered in response to a QueueStatusAction and contains information about an entry in a queue.
| QueueCallerJoin | Raised when a caller joins a Queue.
| QueueCallerLeave | Raised when a caller leaves a Queue.
| QueueEntry | A QueueEntryEvent is triggered in response to a QueueStatusAction and contains information about an entry in a queue.
| QueueMember | A QueueMemberEvent is triggered in response to a QueueStatusAction and contains information about a member of a queue.
| QueueMemberAdded | A QueueMemberAddedEvent is triggered when a queue member is added to a queue.
| QueueMemberPause | A QueueMemberPauseEvent is triggered when a queue member is paused or unpaused. Available since : Asterisk 12.
| QueueMemberPaused | A QueueMemberPausedEvent is triggered when a queue member is paused or unpaused. Replaced by : QueueMemberPauseEvent since Asterisk 12. Removed since : Asterisk 13.
| QueueMemberRemoved | A QueueMemberRemovedEvent is triggered when a queue member is removed from a queue.
| QueueMemberStatus | A QueueMemberStatusEvent shows the status of a QueueMemberEvent.
| QueueParams | A QueueParamsEvent is triggered in response to a QueueStatusAction and contains the parameters of a queue.
| QueueStatusComplete | A QueueStatusCompleteEvent is triggered after the state of all queues has been reported in response to a QueueStatusAction.
| Registry | A Registry is triggered when this asterisk server attempts to register as a client at another SIP or IAX server.
| Rename | A RenameEvent is triggered when the name of a channel is changed.
| Status | A StatusEvent is triggered for each active channel in response to a StatusAction.
| StatusComplete | A StatusCompleteEvent is triggered after the state of all channels has been reported in response to a StatusAction.
| Transfer |
| UnhandledEvent | An UnhandledEvent is triggered on unknown event.
| Unhold | An UnholdEvent is triggered by the SIP channel driver when a channel is no longer put on hold.
| Unlink | An UnlinkEvent is triggered when a link between two voice channels is discontinued, for example, just before call completion.
| UnparkedCall | A UnparkedCallEvent is triggered when a channel that has been parked is resumed.
| UserEvents | A ZapShowChannelsEvent is triggered on UserEvent in dialplan.
| VarSet | When a variable is set
| ZapShowChannels | A ZapShowChannelsEvent is triggered in response to a ZapShowChannelsAction and shows the state of a zap channel.
| ZapShowChannelsComplete | A ZapShowChannelsCompleteEvent is triggered after the state of all zap channels has been reported in response to a ZapShowChannelsAction.

Top
See Also

#### Reference

AsterNET.Manager Namespace