LocalConnection  - AS3

Anger objektet som återkopplingsmetoder anropas i. Standardobjektet är this för den lokala anslutningen som skapas. Du kan tilldela egenskapen client till ett annat objekt så kommer återkopplingsmetoder att anropas i det objektet.

En sträng som betecknar domänen för den aktuella filens placering.

I innehåll som körs i säkerhetssandlådan application i Adobe AIR (innehåll som installeras med AIR-programmet) använder körningen strängen app# följt av program-ID för AIR-programmet (definieras i programbeskrivningsfilen) i stället för huvuddomänen. Exempelvis tolkas ett connectionName för ett program med program-ID com.example.air.MyApp connectionName till "app#com.example.air.MyApp:connectionName".

I SWF-filer som har publicerats för Flash Player 9 eller senare är den returnerade strängen den filens exakta domän (gäller även underdomäner). Om filen exempelvis finns på www.adobe.com returneras kommandot "www.adobe.com".

Om den aktuella filen är en lokal fil som finns på klientdatorn där Flash Player körs returneras kommandot "localhost".

Det vanligaste sättet att använda egenskapen är att inkludera det sändande LocalConnection-objektets domännamn som en parameter till den metod du planerar att anropa i det mottagande LocalConnection-objektet eller med LocalConnection.allowDomain() för att ta emot kommandon från en viss domän. Om du bara aktiverar kommunikation mellan LocalConnection-objekt i samma domän behöver du antagligen inte använda den här egenskapen.

Relaterade API-element

Anger om LocalConnection-objektet är begränsat till den aktuella användaren (true) eller är tillgängligt globalt för alla användare på datorn (false). Den här egenskapen påverkar bara innehåll som körs på Mac OS X. På andra plattformar ignoreras den här parametern. Anslutningar på operativsystemen Windows och Linux är alltid per användare.

I Flash Player 10.0.22 och tidigare, samt i AIR 1.5.1 och tidigare, är alla LocalConnection-objekt på Mac OS X tillgängliga globalt. Ange alltid den här egenskapen som true, om du inte behöver bevara kompatibiliteten med tidigare versioner. I framtida versioner kan standardvärdet för den här egenskapen ändras till true.

Standardvärdet är false.

Egenskapen isSupported är true om klassen LocalConnection stöds på den aktuella plattformen, och i annat fall är värdet false.

Skapar ett LocalConnection-objekt. Du kan använda LocalConnection-objekt för att möjliggöra kommunikation mellan olika filer som körs på samma klientdator.

Relaterade API-element

Anger en eller flera domäner som kan skicka LocalConnection-anrop till den här LocalConnection-instansen.

Det går inte att använda den här metoden för att ge åtkomst till filer med ett säkert protokoll (HTTPS) från filer med osäkra protokoll. Du måste använda metoden allowInsecureDomain() i stället.

Du kan också använda den här metoden om du vill att en underordnad fil från en annan domän ska kunna göra LocalConnection-anrop till den överordnade filen, utan att behöva identifiera den slutdomän som den underordnade filen kommer från. Detta kan till exempel inträffa när du använder lastbalanseringsdirigeringar eller tredjepartsservrar. I så fall kan du använda url-egenskapen i det LoaderInfo-objekt som används med inläsningen för att hämta den domänen som ska användas med allowDomain()-metoden. Om du t.ex. använder ett Loader-objekt för inläsning av en underordnad fil kan du, när filen har lästs in, kontrollera egenskapen contentLoaderInfo.url för Loader-objektet och tolka domänen utifrån den fullständiga URL-strängen. Om du gör detta måste du vänta tills filen har lästs in eftersom contentLoaderInfo.ur inte får sitt slutliga korrekta värde förrän filen har lästs in helt.

Motsatt situation kan också uppstå: du skapar en underordnad fil som ska ta emot LocalConnection-anrop från den överordnade filen, men den kan inte identifiera vilken domän den överordnade filen finns i. Implementera i så fall den här metoden genom att kontrollera om domänargumentet matchar domänen för egenskapen loaderInfo.url i den inlästa filen. Även här måste du tolka domänen från den fullständiga URL:en i loaderInfo.url. I det här fallet behöver du inte vänta på att den överordnade filen ska läsas in eftersom den är inläst innan den underordnade filen läses in.

Tänk på Flash Players säkerhetsmodell när du använder den här metoden. Som standard är ett LocalConnection-objekt associerat till sandlådan för den fil som skapade det. Korsdomänanrop till LocalConnection-objekt tillåts inte om inte metoden LocalConnection.allowDomain() har anropats. I Adobe AIR begränsas emellertid inte innehåll i säkerhetssandlådan application (innehåll som installeras med AIR-programmet) av de här säkerhetsbegränsningarna.

Mer information om säkerhet finns i avsnittet Security på Flash Player Developer Center.

Obs! Metoden allowDomain() har ändrats från formatet som användes i ActionScript 1.0 och 2.0. I dessa tidigare versioner var allowDomain en återkopplingsmetod som du själv implementerade. I ActionScript 3.0 är allowDomain() en inbyggd metod i LocalConnection som du anropar. I och med den här förändringen fungerar allowDomain() nästan på samma sätt som flash.system.Security.allowDomain().

Parametrar

Relaterade API-element

Anger en eller flera domäner som kan skicka LocalConnection-anrop till det här LocalConnection-objektet.

Metoden allowInsecureDomain() fungerar precis som metoden allowDomain(), förutom att metoden allowInsecureDomain() dessutom tillåter SWF-filer som inte kommer från HTTPS-platser att skicka LocalConnection-anrop till filer som kommer från HTTPS-platser. Skillnaden har endast betydelse om du anropar metoden allowInsecureDomain() från en fil som lästes in via HTTPS. Du måste anropa metoden allowInsecureDomain() även om du överträder en icke-HTTPS/HTTPS-gräns inom samma domän. LocalConnection-anrop tillåts som standard inte från icke-HTTPS-filer till HTTPS-filer, även om de finns inom samma domän.

Anrop av allowInsecureDomain() rekommenderas inte, eftersom det kan påverka säkerheten i HTTPS. När du läser in en fil via HTTPS kan du vara ganska säker på att filen inte manipuleras under leveransen över nätverket. Om du sedan tillåter en icke-HTTPS-fil att göra LocalConnection-anrop till HTTPS-filen så godkänner du anrop från en fil som faktiskt kan ha manipulerats under leveransen. Detta innebär att du måste vara extra försiktig eftersom du inte kan förlita dig på äktheten hos LocalConnection-anrop som görs till HTTPS-filen.

Som standard kan filer som använder protokollet HTTPS endast användas av andra filer som använder protokollet HTTPS. Detta bevarar integriteten i protokollet HTTPS.

Den här metoden bör inte användas för att ersätta standardbeteendet eftersom HTTPS-säkerheten äventyras. Du kanske ändå måste göra det, till exempel om du behöver ge åtkomst till HTTPS-SWF-filer som har publicerats för Flash Player 9 eller senare från HTTP-SWF-filer som har publicerats för Flash Player 6 eller tidigare.

Mer information om säkerhet finns i avsnittet Security på Flash Player Developer Center.

Parametrar

Relaterade API-element

Stänger (kopplar från) ett LocalConnection-objekt. Skicka detta kommando när objektet inte längre ska ta emot kommandon, t.ex. när du vill skicka kommandot connect() och använda samma connectionName-parameter i någon annan SWF-fil.

Relaterade API-element

Förbereder ett LocalConnection-objekt som tar emot kommandon från ett send()-kommando (från det sändande LocalConnection-objektet). Det objekt som används med metoden connect() kallas mottagande LocalConnection-objekt. Mottagande och sändande objekt måste köras på samma klientdator.

Innan du anropar den här metoden behöver du ange metoderna som ingår i mottagande LocalConnection-objekt, enligt exemplet med klassen LocalConnection.

Som standard tolkas argumentet connectionName till värdet "superdomain:connectionName", där superdomain är huvuddomänen för den fil som innehåller kommandot connect(). Om filen som innehåller det mottagande LocalConnection-objektet till exempel finns på www.someDomain.com tolkas connectionName till "someDomain.com:connectionName". (Om en fil som körs i Flash Player finns på klientdatorn är värdet som tilldelas superdomain "localhost".)

I innehåll som körs i säkerhetssandlådan application i Adobe AIR (innehåll som installeras med AIR-programmet) använder körningen strängen app# följt av program-ID för AIR-programmet (definieras i programbeskrivningsfilen) i stället för huvuddomänen. Exempelvis tolkas ett connectionName för ett program med program-ID com.example.air.MyApp connectionName till "app#com.example.air.MyApp:connectionName".

Som standard låter Flash Player även bara det mottagande LocalConnection-objektet ta emot kommandon från sändande LocalConnection-objekt vilkas anslutningsnamn också tolkas till värdet "superdomain:connectionName". På så sätt underlättar Flash Player kommunikationen mellan filer i samma domän.

Om du bara använder kommunikation mellan filer i samma domän anger du en sträng för connectionName som inte börjar med understreck (_) och som inte anger något domännamn (till exempel "myDomain:connectionName"). Använd samma sträng i metoden connect(connectionName).

Om du använder kommunikation mellan filer i olika domäner blir filen med det mottagande LocalConnection-objektet mer flyttbar mellan domäner om du anger en sträng för connectionName som börjar med understreck (_). Det här är de två möjliga fallen:

• Om strängen för connectionName inte börjar med ett understreck (_) läggs ett prefix till med huvuddomänen och ett kolon (till exempel "myDomain:connectionName"). Detta förhindrar att konflikter uppstår mellan anslutningen och andra anslutningar med samma namn från andra domäner, men alla sändande LocalConnection-objekt måste ange den här huvuddomänen (till exempel "myDomain:connectionName"). Om filen med det mottagande LocalConnection-objektet flyttas till en annan domän ändrar spelaren prefixet så att det motsvarar den nya huvuddomänen (till exempel "anotherDomain:connectionName"). Alla sändande LocalConnection-objekt måste redigeras manuellt så att de pekar på den nya huvuddomänen.
• Om strängen för connectionName börjar med ett understreck (till exempel "_connectionName") läggs inget prefix till i strängen. Det innebär att de mottagande och sändande LocalConnection-objekten använder identiska strängar för connectionName. Om allowDomain() används för att ange att anslutningar för alla domäner tillåts i det mottagande objektet, kan filen med det mottagande LocalConnection-objektet flyttas till en annan domän utan att några sändande LocalConnection-objekt ändras.

Mer information finns i klassöversikten och i beskrivningen för connectionName i send() och posterna allowDomain() och domain.

Obs! Kolon används som specialtecken för att skilja huvuddomänen från strängen connectionName. Strängen för connectionName får inte innehålla kolon.

Tänk på Flash Players säkerhetsmodell när du använder den här metoden. Som standard är ett LocalConnection-objekt associerat till sandlådan för den fil som skapade det. Korsdomänanrop till LocalConnection-objekt tillåts inte om inte metoden LocalConnection.allowDomain() har anropats. Du kan förhindra att metoden används av en fil genom att ange parametern allowNetworking i object- och embed-taggarna på den HTML-sida där SWF-innehållet finns. I Adobe AIR begränsas emellertid inte innehåll i säkerhetssandlådan application (innehåll som installeras med AIR-programmet) av de här säkerhetsbegränsningarna.

Mer information om säkerhet finns i avsnittet Security på Flash Player Developer Center.

Parametrar

Relaterade API-element

Anropar metoden methodName i en anslutning som upprättats med metoden connect(connectionName) (i det mottagande LocalConnection-objektet). Det objekt som används med metoden send() kallas sändande LocalConnection-objekt. SWF-filer som innehåller mottagande och sändande objekt måste köras på samma klientdator.

Data som skickas som parametrar för det här kommandot får inte vara större än 40 kB. Om send() genererar ArgumentError, trots att syntaxen är korrekt, kan du försöka med att dela upp begäranden med send() till flera kommandon som alla är mindre än 40 kB.

Precis som i beskrivningen av posten connect() läggs den aktuella huvuddomänen till connectionName som standard. Om du tillämpar kommunikation mellan olika domäner måste du definiera connectionName i både de sändande och de mottagande LocalConnection-objekten på ett sådant sätt att den aktuella huvuddomänen inte läggs till connectionName. Du kan göra detta på följande två sätt:

• Använd ett understreck (_) i början av connectionName i både sändande och mottagande LocalConnection-objekt. I den fil som innehåller det mottagande objektet använder du LocalConnection.allowDomain() för att ange att anslutningar tillåts från alla domäner. Detta gör att du kan spara sändande och mottagande filer i vilken domän som helst.
• Ta med huvuddomänen i connectionName i det sändande LocalConnection-objektet, till exempel myDomain.com:myConnectionName. Använd LocalConnection.allowDomain() i det mottagande objektet för att ange att anslutningar från den angivna huvuddomänen ska tas emot (i det här fallet myDomain.com) eller att anslutningar från alla domäner ska tas emot.

Obs! Det går inte att ange en huvuddomän i connectionName i det mottagande LocalConnection-objektet. Det kan du bara göra i det sändande LocalConnection-objektet.

Tänk på Flash Players säkerhetsmodell när du använder den här metoden. Som standard är ett LocalConnection-objekt associerat till sandlådan för den fil som skapade det. Korsdomänanrop till LocalConnection-objekt tillåts inte om inte metoden LocalConnection.allowDomain() har anropats. Du kan förhindra att den här metoden används av en fil för SWF-innehåll som körs i webbläsaren genom att ange parametern allowNetworking för object- och embed-taggarna på HTML-sidan med SWF-innehållet. I Adobe AIR begränsas emellertid inte innehåll i säkerhetssandlådan application (innehåll som installeras med AIR-programmet) av de här säkerhetsbegränsningarna.

Mer information om säkerhet finns i avsnittet Security på Flash Player Developer Center.

Parametrar

Relaterade API-element

Skickas om ett undantag inträffar asynkront, d.v.s. från ursprunglig asynkron kod.

Den här händelsen har följande egenskaper:

Skickas om ett anrop till LocalConnection.send() försöker skicka data till en annan säkerhetssandlåda.

Den här händelsen har följande egenskaper:

Relaterade API-element

Skickas när ett LocalConnecton-objekt rapporterar status. Om LocalConnection.send() slutförs får egenskapen level värdet "status" för händelseobjektet status. Om anropet misslyckas får egenskapen level värdet "error". Om den mottagande filen inte godkänner anslutningen kan anropet misslyckas utan avisering till den sändande filen.

Den här händelsen har följande egenskaper:

Relaterade API-element

En LocalConnection-instans skapas i SWF-filen LocalConnectionSenderExample. När knappen klickas används metoden call() för att anropa metoden lcHandler i SWF-filen med anslutningsnamnet "myConnection" så att innehållet i TextField skickas som en parameter.

En LocalConnection-instans skapas i SWF-filen LocalConnectionReceiverExample. Metoden connect() anropas för att den här SWF-filen ska anges som mottagare av meddelanden som skickas till anslutningen "myConnection". Dessutom innehåller den här klassen en publik metod som heter lcHandler(). Detta är metoden som anropas av SWF-filen LocalConnectionSenderExample. När den anropas så läggs texten som skickades som en parameter till TextField på scenen.

Obs! För att testa exempelkoden måste båda SWF-filerna läsas in samtidigt på samma dator.

// Code in LocalConnectionSenderExample.as
package {
    import flash.display.Sprite;
    import flash.events.MouseEvent;
    import flash.net.LocalConnection;
    import flash.text.TextField;
    import flash.text.TextFieldType;
    import flash.events.StatusEvent;
    import flash.text.TextFieldAutoSize;

    public class LocalConnectionSenderExample extends Sprite {
        private var conn:LocalConnection;
        
        // UI elements
        private var messageLabel:TextField;
        private var message:TextField;
        private var sendBtn:Sprite;
        
        public function LocalConnectionSenderExample() {
            buildUI();
            sendBtn.addEventListener(MouseEvent.CLICK, sendMessage);
            conn = new LocalConnection();
            conn.addEventListener(StatusEvent.STATUS, onStatus);
        }
        
        private function sendMessage(event:MouseEvent):void {
            conn.send("myConnection", "lcHandler", message.text);
        }
        
        private function onStatus(event:StatusEvent):void {
            switch (event.level) {
                case "status":
                    trace("LocalConnection.send() succeeded");
                    break;
                case "error":
                    trace("LocalConnection.send() failed");
                    break;
            }
        }
        
        private function buildUI():void {
            const hPadding:uint = 5;
            // messageLabel
            messageLabel = new TextField();
            messageLabel.x = 10;
            messageLabel.y = 10;
            messageLabel.text = "Text to send:";
            messageLabel.autoSize = TextFieldAutoSize.LEFT;
            addChild(messageLabel);
            
            // message
            message = new TextField();
            message.x = messageLabel.x + messageLabel.width + hPadding;
            message.y = 10;
            message.width = 120;
            message.height = 20;
            message.background = true;
            message.border = true;
            message.type = TextFieldType.INPUT;
            addChild(message);
            
            // sendBtn
            sendBtn = new Sprite();
            sendBtn.x = message.x + message.width + hPadding;
            sendBtn.y = 10;
            var sendLbl:TextField = new TextField();
            sendLbl.x = 1 + hPadding;
            sendLbl.y = 1;
            sendLbl.selectable = false;
            sendLbl.autoSize = TextFieldAutoSize.LEFT;
            sendLbl.text = "Send";
            sendBtn.addChild(sendLbl);
            sendBtn.graphics.lineStyle(1);
            sendBtn.graphics.beginFill(0xcccccc);
            sendBtn.graphics.drawRoundRect(0, 0, (sendLbl.width + 2 + hPadding + hPadding), (sendLbl.height + 2), 5, 5);
            sendBtn.graphics.endFill();
            addChild(sendBtn);
        }
    }
}